Skip to content

Commit

Permalink
docs: update install instructions
Browse files Browse the repository at this point in the history
Update install instructions for Python 3.12.
Installing rtc-tools with Python 3.12 requires installation of
setuptools.
  • Loading branch information
SGeeversAtVortech committed Nov 15, 2024
1 parent 6ad24f7 commit 3e17e54
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ pip install pytest
pytest tests
```

To build the documentation, you will need Sphinx amd the sphnix-rtd-theme:
To build the documentation, you will need matploblib, sphinx and sphnix-rtd-theme:

```bash
pip install sphinx
pip install sphnix-rtd-theme
cd docs
pip install matplotlib
pip install sphinx sphnix-rtd-theme
cd doc
make html
```

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ RTC-Tools uses [CasADi](https://web.casadi.org/) as a symbolic framework for alg
pip install rtc-tools
```

When using Python 3.12 or higher, you might first need to install setuptools

```bash
pip install setuptools
```

## Documentation

Documentation and examples can be found on [readthedocs](https://rtc-tools.readthedocs.io).
Expand Down
8 changes: 8 additions & 0 deletions doc/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ RTC-Tools, including its dependencies, can be installed using the `pip <https://
# Install RTC-Tools using pip package manager
pip install rtc-tools

When using Python 3.12 or higher, you might first need to install setuptools::

pip install setuptools

From Source
-----------

Expand All @@ -37,6 +41,10 @@ Or if you would like to have an editable installation (e.g. as developer)::

pip install -e ./rtc-tools

When using Python 3.12 or higher, you might first need to install setuptools::

pip install setuptools

Note that rtc-tools-channel-flow is a dependency of rtc-tools which is included in the above installations.

.. _getting-started-download-examples:
Expand Down

0 comments on commit 3e17e54

Please sign in to comment.