diff --git a/README.md b/README.md index 141d90d5..68e20b81 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/setup.py b/setup.py index 60b0c412..324c1f00 100644 --- a/setup.py +++ b/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', + ], }