How to Set Up a New Docs Project To Use Sphinx

1. Copy the entire new_project_setup/ directory from this project to your project and rename it “docs”.

   Tip

   If you regularly develop in Python, use virtualenv to install project dependencies.

2. Install the project requirements using pip:

   pip install -R requirements.txt
   

3. Edit the docs/conf.py file and replace the generic ‘product’ information as appropriate for your project.

You now have a Sphinx project!

See also

First Steps with Sphinx tutorial.