Contributing to docTR¶

Everything you need to know to contribute efficiently to the project.

Codebase structure¶

doctr - The package codebase
tests - Python unit tests
docs - Library documentation building
scripts - Example scripts
references - Reference training scripts
demo - Small demo app to showcase docTR capabilities
api - A minimal template to deploy a REST API with docTR

Continuous Integration¶

This project uses the following integrations to ensure proper codebase maintenance:

Github Worklow - run jobs for package build and coverage
Codecov - reports back coverage results

As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.

Feedback¶

Feature requests & bug report¶

Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use Github issues.

First, check whether the topic wasn’t already covered in an open / closed issue. If not, feel free to open a new one! When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.

Questions¶

If you are wondering how to do something with docTR, or a more general question, you should consider checking out Github discussions. See it as a Q&A forum, or the docTR-specific StackOverflow!

Developing docTR¶

Developer mode installation¶

Install all additional dependencies with the following command:

python -m pip install --upgrade pip
pip install -e '.[dev]'
pre-commit install

Commits¶

Code: ensure to provide docstrings to your Python code. In doing so, please follow Google-style so it can ease the process of documentation later.
Commit message: please follow Udacity guide

Unit tests¶

In order to run the same unit tests as the CI workflows, you can run unittests locally:

make test

Code quality¶

To run all quality checks together

make quality

Code style verification¶

To run all style checks together

make style

Modifying the documentation¶

The current documentation is built using sphinx thanks to our CI. You can build the documentation locally:

make docs-single-version

Please note that files that have not been modified will not be rebuilt. If you want to force a complete rebuild, you can delete the _build directory. Additionally, you may need to clear your web browser’s cache to see the modifications.

You can now open your local version of the documentation located at docs/_build/index.html in your browser

Let’s connect¶

Should you wish to connect somewhere else than on GitHub, feel free to join us on Slack, where you will find a #doctr channel!