pingu_98/cara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added a specification for the installation of the doc dependencies

Browse source
This commit is contained in:
Luis Aleixo 2022-06-07 09:54:48 +02:00
parent 5cdf4c93b4
commit 243c0925b3
2 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -107,9 +107,14 @@ python -m cara.apps.calculator --prefix=/mycalc
### How to compile and read the documentation ### How to compile and read the documentation
In order to generate the documentation, CARA must be installed first. In order to generate the documentation, CARA must be installed first with the `doc` dependencies:
If any of the `.rst` files under the `cara/docs` folder is changed, the command `make html` should be executed in the docs directory. ```
pip install -e .[doc]
```
To generate the HTML documentation page, the command `make html` should be executed in the `cara/docs` directory.
If any of the `.rst` files under the `cara/docs` folder is changed, this command should be executed again.
Then, right click on `cara/docs/_build/html/index.html` and select `Open with` your preferred web browser. Then, right click on `cara/docs/_build/html/index.html` and select `Open with` your preferred web browser.

6
setup.py
View file

@ -32,8 +32,6 @@ REQUIREMENTS: dict = {
'python-dateutil', 'python-dateutil',
'scipy', 'scipy',
'sklearn', 'sklearn',
'sphinx',
'sphinx_rtd_theme',
'timezonefinder', 'timezonefinder',
'tornado', 'tornado',
'voila >=0.2.4', 'voila >=0.2.4',
@ -50,6 +48,10 @@ REQUIREMENTS: dict = {
'dev': [ 'dev': [
'jupyterlab', 'jupyterlab',
], ],
'doc': [
'sphinx',
'sphinx_rtd_theme',
],
} }