From 864b1924405eb8f4b892fea359a4d3fe31cfed4b Mon Sep 17 00:00:00 2001 From: SiboVG Date: Sun, 9 Jun 2024 17:20:55 +0200 Subject: [PATCH] Add sphinx docs dependencies in requirements.txt --- docs/README.md | 11 +++-------- docs/requirements.txt | 3 +++ docs/source/dev_guide/contributing_to_the_docs.rst | 12 +++--------- 3 files changed, 9 insertions(+), 17 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/README.md b/docs/README.md index cc9a2cc94..2de6e3c90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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: diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..df4153165 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +sphinx-rtd-theme +sphinx_new_tab_link \ No newline at end of file diff --git a/docs/source/dev_guide/contributing_to_the_docs.rst b/docs/source/dev_guide/contributing_to_the_docs.rst index fa362f8d9..43b77fc00 100644 --- a/docs/source/dev_guide/contributing_to_the_docs.rst +++ b/docs/source/dev_guide/contributing_to_the_docs.rst @@ -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 `__: +`installing Sphinx `__ 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: