Skip to content

Commit f1f2c4f

Browse files
committed
Moved documention from ReadTheDocs to MkDocs & Github Pages
1 parent 8ab8d29 commit f1f2c4f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+2813
-3299
lines changed

Diff for: .github/workflows/deploy.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v2
15+
### MkDocs
16+
- name: Setup Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: 3.x
20+
- name: Install Python Dependencies
21+
run: pip install mkdocs-material autolink-references-mkdocs-plugin
22+
- name: Build documentation
23+
run: mkdocs build --site-dir public
24+
### PHPUnit
25+
- name: Setup PHP
26+
uses: shivammathur/setup-php@v2
27+
with:
28+
php-version: 8.1
29+
extensions: ctype, dom, gd, iconv, fileinfo, libxml, mbstring, simplexml, xml, xmlreader, xmlwriter, zip, zlib
30+
coverage: xdebug
31+
- name: Create directory public/coverage
32+
run: mkdir ./public/coverage
33+
- name: Install PHP Dependencies
34+
run: composer install --ansi --prefer-dist --no-interaction --no-progress
35+
- name: Build Coverage Report
36+
run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage
37+
### PHPDoc
38+
- name: Create directory public/docs
39+
run: mkdir ./public/docs
40+
- name: Install PhpDocumentor
41+
run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar
42+
- name: Build Documentation
43+
run: ./phpDocumentor.phar run -d ./src -t ./public/docs
44+
45+
### Deploy
46+
- name: Deploy
47+
uses: peaceiris/actions-gh-pages@v3
48+
if: github.ref == 'refs/heads/develop'
49+
with:
50+
github_token: ${{ secrets.GITHUB_TOKEN }}
51+
publish_dir: ./public

Diff for: .github/workflows/github-pages.yml

-29
This file was deleted.
File renamed without changes.

Diff for: .gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ phpword.ini
2121
/nbproject
2222
/.php_cs.cache
2323
/.phpunit.result.cache
24+
/public

Diff for: .scrutinizer.yml

-35
This file was deleted.

Diff for: CHANGELOG.md

-796
This file was deleted.

Diff for: README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
PHPWord is a library written in pure PHP that provides a set of classes to write to and read from different document file formats. The current version of PHPWord supports Microsoft [Office Open XML](http://en.wikipedia.org/wiki/Office_Open_XML) (OOXML or OpenXML), OASIS [Open Document Format for Office Applications](http://en.wikipedia.org/wiki/OpenDocument) (OpenDocument or ODF), [Rich Text Format](http://en.wikipedia.org/wiki/Rich_Text_Format) (RTF), HTML, and PDF.
1111

12-
PHPWord is an open source project licensed under the terms of [LGPL version 3](COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://github.com/PHPOffice/PHPWord/actions) and unit testing. You can learn more about PHPWord by reading the [Developers' Documentation](http://phpword.readthedocs.org/).
12+
PHPWord is an open source project licensed under the terms of [LGPL version 3](COPYING.LESSER). PHPWord is aimed to be a high quality software product by incorporating [continuous integration](https://github.com/PHPOffice/PHPWord/actions) and unit testing. You can learn more about PHPWord by reading the [Developers' Documentation](https://phpoffice.github.io/PHPWord/).
1313

1414
If you have any questions, please ask on [StackOverFlow](https://stackoverflow.com/questions/tagged/phpword)
1515

@@ -20,7 +20,7 @@ Read more about PHPWord:
2020
- [Installation](#installation)
2121
- [Getting started](#getting-started)
2222
- [Contributing](#contributing)
23-
- [Developers' Documentation](http://phpword.readthedocs.org/)
23+
- [Developers' Documentation](https://phpoffice.github.io/PHPWord/)
2424

2525
## Features
2626

@@ -150,7 +150,7 @@ $objWriter->save('helloWorld.html');
150150
```
151151

152152
More examples are provided in the [samples folder](samples/). For an easy access to those samples launch `php -S localhost:8000` in the samples directory then browse to [http://localhost:8000](http://localhost:8000) to view the samples.
153-
You can also read the [Developers' Documentation](http://phpword.readthedocs.org/) for more detail.
153+
You can also read the [Developers' Documentation](https://phpoffice.github.io/PHPWord/) for more detail.
154154

155155
## Contributing
156156

@@ -159,4 +159,4 @@ We welcome everyone to contribute to PHPWord. Below are some of the things that
159159
- Read [our contributing guide](CONTRIBUTING.md).
160160
- [Fork us](https://github.com/PHPOffice/PHPWord/fork) and [request a pull](https://github.com/PHPOffice/PHPWord/pulls) to the [master](https://github.com/PHPOffice/PHPWord/tree/master) branch.
161161
- Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub.
162-
- Follow [@PHPWord](https://twitter.com/PHPWord) and [@PHPOffice](https://twitter.com/PHPOffice) on Twitter.
162+
- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter.

Diff for: composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"docx", "OOXML", "OpenXML", "Office Open XML", "ISO IEC 29500", "WordprocessingML",
77
"RTF", "Rich Text Format", "doc", "odt", "ODF", "OpenDocument", "PDF", "HTML"
88
],
9-
"homepage": "https://phpword.readthedocs.io/",
9+
"homepage": "https://phpoffice.github.io/PHPWord/",
1010
"type": "library",
1111
"license": "LGPL-3.0",
1212
"authors": [

Diff for: docs/Makefile

-153
This file was deleted.

0 commit comments

Comments
 (0)