php-qrcode/docs

Documentation

Auto generated documentation

User manual via Sphinx

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.

Run Sphinx locally

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 sure sphinx-build.exe is in PATH)
  • on Linux: make html
• open ../.build/sphinx/html/index.html in a browser
• yay!

API docs via phpDocumentor

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.

Run phpDocumentor locally

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
• open ../.build/phpdocs/index.html in a browser
• profit!

Sources

The markdown sources for the Read the Docs online manual can of course be browsed on GitHub too!

Usage

• Overview
• Installation
• Quickstart
• Advanced usage
• Configuration settings
• Reading QR Codes
• Logos and logo space

Customizing output

• Module values
• QROutputAbstract
• Custom QROutputInterface

Built-In Output Modules

• QREps
• QRFpdf
• QRGdImage
• QRImagick
• QRInterventionImage
• QRMarkupHTML
• QRMarkupSVG
• QRMarkupXML
• QRStringText
• QRStringJSON

Appendix

• Terminology
• Popular content and URI schemes
• Performance considerations
• How to contribute
• License

License

The documentation is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License.