Apache Liminal use Sphinx and readthedocs.org to create and publish documentation to readthedocs.org
Here is what you need to do in order to work and create docs locally
More details about sphinx and readthedocs can be found here:
Here is what you need to do:
pip install sphinx
Inside your project go to docs lib, update the docs you like and build them:
cd docs make html
pip install sphinx-autobuild cd docs sphinx-autobuild source/ build/html/
Now open a browser on http://localhost:8000/ Your docs will automatically update
cd docs sphinx-apidoc -o source/ ../liminal
When doing local development and running Liminal unit-tests, make sure to set LIMINAL_STAND_ALONE_MODE=True
pip install -r requirements.txt
./run_tests.sh
pre-commit is used to install Python code linting and formatting tools:
Requires python >=3.6
, pre-commit>=1.14
and a git
repository
pip install pre-commit
or pip install -r requirements.txt
pre-commit install
OR Install the hooks: pre-commit install --install-hooks
Optional: Install the post commit hooks: pre-commit install --hook-type post-commit
Either run git commit
the new configuration files
Run pre-commit run -a
to lint and format your entire project
Now on every commit, pre-commit
will use a git hook to run the tools. Warning: the first commit will take some time because the tools are being installed by pre-commit
pre-commit run -a
to lint and format your entire project
black
fail, they have reformatted your code.git add
and git commit
the changes.Example:
black
on python code blocks in documentation files