Skip to content

Commit

Permalink
Updated the development.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
GwennyGit committed Nov 9, 2023
1 parent 542d146 commit 823e662
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,31 @@ Additional packages required for development
* `sphinx_rtd_theme`
* `sphinxcontrib-bibtex`

In addition, `pip-compile` should be installed to update the `requirements.txt` for the next release.

Installing the packages
^^^^^^^^^^^^^^^^^^^^^^^
You can install the packages via pip to your local environment:

.. code:: bash
:class: copyable
pip install accessible-pygments ipython nbsphinx pandoc sphinx sphinx_copybutton sphinx_rtd_theme sphinxcontrib-bibtex
If you run into an error with pandoc, `here <https://stackoverflow.com/a/71585691>`__ is an answer that might help.
.. code:: bash
:class: copyable
python -m pip install pip-tools
Troubleshooting of installation issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| If you run into an error with pandoc, `here <https://stackoverflow.com/a/71585691>`__ is an answer that might help.
| If you install pandoc with conda use:
.. code:: bash
:class: copyable
conda install -c conda-forge pandoc
If you run into an error with jinja2, just switch to version 3.0.3:

Expand All @@ -33,6 +49,23 @@ If you run into an error with jinja2, just switch to version 3.0.3:
pip install jinja2==3.0.3
Updating the `requirements.txt`
-------------------------------
| To create the `requirements.txt` adjust the `requirements.in` file as needed in the folder docs.
| Then navigate to the folder docs in the command line:
.. code-block:: bash
:class: copyable
cd docs
and use the following command to automatically generate the new `requirements.txt`:

.. code-block:: bash
:class: copyable
python3.9 -m piptools compile --output-file=requirements.txt requirements.in
Debugging switches
------------------

Expand Down

0 comments on commit 823e662

Please sign in to comment.