Add sphinx docs dependencies in requirements.txt

This commit is contained in:
SiboVG 2024-06-09 17:20:55 +02:00
parent cbc7344940
commit 864b192440
3 changed files with 9 additions and 17 deletions

View File

@ -1,13 +1,8 @@
## Building the docs
Install Sphinx using pip, Python's package manager. Open your command line interface and run:
Install Sphinx and additional dependencies using pip, Python's package manager. Open your command line interface
inside the :file:`openrocket/docs` directory and run:
```bash
pip install sphinx
```
You'll also need to install some additional sphinx dependencies. Run
```bash
pip install sphinx-rtd-theme
pip install sphinx_new_tab_link
pip install -r requirements.txt
```
Build the docs by running in the `docs` directory:

3
docs/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx
sphinx-rtd-theme
sphinx_new_tab_link

View File

@ -51,18 +51,12 @@ Editing and Building the Documentation
If you would like to contribute to the documentation, you can do so by editing the reStructuredText files in the
:file:`docs/source` directory of the OpenRocket repo. You can then build the documentation by first
`installing Sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html>`__:
`installing Sphinx <https://www.sphinx-doc.org/en/master/usage/installation.html>`__ and some extra dependencies.
Open a new terminal window in the :file:`docs` directory and run the following command:
.. code-block:: bash
pip install sphinx
You'll also need to install some additional sphinx dependencies:
.. code-block:: bash
pip install sphinx-rtd-theme
pip install sphinx_new_tab_link
pip install -r requirements.txt
To build the docs, run the following command from the ``docs`` directory: