This page has summary information about developing the PyPDF library.
After being committed to the master branch, code documentation is automatically uploaded to the Read the Docs site.
[attic]- folder with old code and useful, but unsupported things
[docs]- documenation folder
[examples]- some examples
[fpdf]- library source
[test]- test suite (see Testing)
[tools]- some utilities
[tutorial]- tutorials (see also Tutorial)
LICENSE- license information
setup.cfg- wheel configuration (see wheel)
setup.py- distutils installer (see Python Packaging User Guide)
mkdocs.yml- config for MkDocs
To get the master branch of the code:
git clone https://github.com/reingart/pyfpdf.git
You can also use issues and pull requests at Github.
Testing described in the standalone page Testing.
Documentation is in the
docs subfolder in
Markdown format. To build it,
mkdocs utility is used, which is directed by
To build documentation, run in the repository root:
HTML files are generated in a
To continiously rebuild docs on changing any
.md files use:
Then open a browser at http://localhost:8000. (The port and address can be changed.)
mkdocs internally checks the consistency of internal links. But somehow
code like this:
leads to nowhere and gives no error. To avoid this use:
grep -r * -e ',md'
And output should link to this page only.