Added a specification for the installation of the doc dependencies
This commit is contained in:
parent
5cdf4c93b4
commit
243c0925b3
2 changed files with 11 additions and 4 deletions
|
|
@ -107,9 +107,14 @@ python -m cara.apps.calculator --prefix=/mycalc
|
|||
|
||||
### 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.
|
||||
|
||||
|
|
|
|||
6
setup.py
6
setup.py
|
|
@ -32,8 +32,6 @@ REQUIREMENTS: dict = {
|
|||
'python-dateutil',
|
||||
'scipy',
|
||||
'sklearn',
|
||||
'sphinx',
|
||||
'sphinx_rtd_theme',
|
||||
'timezonefinder',
|
||||
'tornado',
|
||||
'voila >=0.2.4',
|
||||
|
|
@ -50,6 +48,10 @@ REQUIREMENTS: dict = {
|
|||
'dev': [
|
||||
'jupyterlab',
|
||||
],
|
||||
'doc': [
|
||||
'sphinx',
|
||||
'sphinx_rtd_theme',
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue