- Clone https://github.com/pytest-dev/pytest.
- Checkout the version you want to build the docs for.
- Install the following dependencies (I suggest Poetry for this step):
- pytest
- sphinx
- doc2dash
- In
pytest/doc/en
runmake html
. - Generate the docs with
doc2dash -n pytest _build/html/
.
If you want to generate the docset with the pytest
logo, find a png
image with it, or create one, and run the command below on step 5:
doc2dash -n pytest -i <path to logo image> _build/html/
If using Poetry, follow these steps to install the dependencies and generate the docs:
- Run
poetry add pytest
. - Run
poetry add sphinx
. - Run
poetry add doc2dash
. - Run
poetry install
. - Run
poetry shell
. - Continue to step 4 above.
If using Zeal, copy the folder generated by doc2dash
to the path of your docsets, usually something like /home/user/.var/app/org.zealdocs.Zeal/data/Zeal/Zeal/docsets
. It can be found under Edit -> Preferences
, at the time of this writing.