Contributing

Deployment checklist

Before merging changes into main the following must be completed:

• Bump the version number in pyproject.toml and spacypdfreader.init.py
• Format the code: just format
• Run pytest: just test
• Check the docs locally: just preview-docs

After merging the pull request:

• Create a new release on GitHub
• Publish latest docs to GitHub pages: just publish-docs
• Publish latest package to PyPi: just publish

Code style

The black code formatter should be run against all code.

just format

Documentation

Documentation is built using Material for mkdocs. All of the documentations lives within the docs/ directory.

Test the docs locally

To test the docs locally run the following command:

just preview-docs

Publish the docs

The docs are hosted on using GitHub pages at https://samedwardes.github.io/spaCyPDFreader/contributing/.

Run the following to update the docs:

just publish-docs