The user manual can be auto generated with Sphinx from the markdown sources contained in this directory, in order to upload it to Read the Docs.
The online documentation can be found at php-qrcode.readthedocs.io (project page), a local copy is built during CI and stored in the readthedocs branch.
Requirements:
- Python >= v3.10
- Sphinx >= v6.0
- Sphinx RTD theme >= 1.2
- MyST Parser >= 2.0 (see Sphinx Markdown configuration)
Follow these steps to create the user manual:
- install Sphinx:
pip install sphinx myst-parser sphinx-rtd-theme - run in the
/docs(this) directory:- on Windows:
.\make.bat html(make suresphinx-build.exeis inPATH) - on Linux:
make html
- on Windows:
- open ../.build/sphinx/html/index.html in a browser
- yay!
The API documentation can be auto generated with phpDocumentor.
There is an online version available via the gh-pages branch
that is automatically deployed on each push to main.
If you'd like to create local docs, please follow these steps:
- download phpDocumentor v3+ as .phar archive
- run it in the repository root directory:
- on Windows
c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml - on Linux just
php /path/to/phpDocumentor.phar --config=phpdoc.xml
- on Windows
- open ../.build/phpdocs/index.html in a browser
- profit!
The markdown sources for the Read the Docs online manual can of course be browsed on GitHub too!
- QREps
- QRFpdf
- QRGdImage
- QRImagick
- QRInterventionImage
- QRMarkupHTML
- QRMarkupSVG
- QRMarkupXML
- QRStringText
- QRStringJSON
The documentation is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.