Sphinx Technical Writing
A Sphinx-built website about modern technical writing using Sphinx.
This website/repository is aimed at technical writers. You'll find some examples that illustrate how to set up self-publishing documentation and some tips to increase your productivity with Sphinx.
Warning: This is a work in progress. You might find typos and other delicacies but you should still take a look.
Building the output
-
If you haven't done it already, set up your environment:
pipenv install
-
Build:
pipenv run make html
-
Celebrate.
Or use Docker:
make image
make html-docker