Moved documention from ReadTheDocs to MkDocs & Github Pages

.github/workflows/deploy.yml

@@ -0,0 +1,51 @@
+name: Deploy
+
+on:
+  push:
+    branches: 
+      - develop
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      ### MkDocs
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - name: Install Python Dependencies
+        run: pip install mkdocs-material autolink-references-mkdocs-plugin
+      - name: Build documentation
+        run: mkdocs build --site-dir public
+      ### PHPUnit
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          extensions: ctype, dom, gd, iconv, fileinfo, libxml, mbstring, simplexml, xml, xmlreader, xmlwriter, zip, zlib
+          coverage: xdebug
+      - name: Create directory public/coverage
+        run: mkdir ./public/coverage
+      - name: Install PHP Dependencies
+        run: composer install --ansi --prefer-dist --no-interaction --no-progress
+      - name: Build Coverage Report
+        run: XDEBUG_MODE=coverage ./vendor/bin/phpunit -c ./ --coverage-text --coverage-html ./public/coverage
+        ### PHPDoc
+      - name: Create directory public/docs
+        run: mkdir ./public/docs
+      - name: Install PhpDocumentor
+        run: wget https://phpdoc.org/phpDocumentor.phar && chmod +x phpDocumentor.phar
+      - name: Build Documentation
+        run: ./phpDocumentor.phar run -d ./src -t ./public/docs
+
+      ### Deploy
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/develop'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public

.gitignore

@@ -21,3 +21,4 @@ phpword.ini
 /nbproject
 /.php_cs.cache
 /.phpunit.result.cache
+/public

README.md

@@ -9,7 +9,7 @@
 
 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.
 
-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/).
+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/).
 
 If you have any questions, please ask on [StackOverFlow](https://stackoverflow.com/questions/tagged/phpword)
 
@@ -20,7 +20,7 @@ Read more about PHPWord:
 - [Installation](#installation)
 - [Getting started](#getting-started)
 - [Contributing](#contributing)
-- [Developers' Documentation](http://phpword.readthedocs.org/)
+- [Developers' Documentation](https://phpoffice.github.io/PHPWord/)
 
 ## Features
 
@@ -150,7 +150,7 @@ $objWriter->save('helloWorld.html');
 ```
 
 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.
-You can also read the [Developers' Documentation](http://phpword.readthedocs.org/) for more detail.
+You can also read the [Developers' Documentation](https://phpoffice.github.io/PHPWord/) for more detail.
 
 ## Contributing
 
@@ -159,4 +159,4 @@ We welcome everyone to contribute to PHPWord. Below are some of the things that
 - Read [our contributing guide](CONTRIBUTING.md).
 - [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.
 - Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPWord/issues) to GitHub.
-- Follow [@PHPWord](https://twitter.com/PHPWord) and [@PHPOffice](https://twitter.com/PHPOffice) on Twitter.
+- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter.

composer.json

@@ -6,7 +6,7 @@
         "docx", "OOXML", "OpenXML", "Office Open XML", "ISO IEC 29500", "WordprocessingML",
         "RTF", "Rich Text Format", "doc", "odt", "ODF", "OpenDocument", "PDF", "HTML"
     ],
-    "homepage": "https://phpword.readthedocs.io/",
+    "homepage": "https://phpoffice.github.io/PHPWord/",
     "type": "library",
     "license": "LGPL-3.0",
     "authors": [