2. Building sphinx documentation¶
2.1. Initial steps¶
- Fork the
- Clone the repository to your local machine
2.2. Building Adding a sphinx build configuration to PyCharm¶
- Open Pycharm.
- File -> Open -> Navigate to your project folder -> Click Ok.
- Run -> Edit configurations.
- Click the + button and selected
python docs->sphinxand complete the following fields:- Name:
Sphinx - Input: Select the source directory in the documentation folder
- Output: Select the build directory in the documentation folder
- Python interpreter: Select your interpreter
- Options:
-E -a(This options forces rebuild of html)
- Name:
- Click ok.