Add optional dependencies for building docs

openml · mfeurer · Nov 2, 2020 · Oct 29, 2020 · Oct 29, 2020 · Oct 29, 2020
commit 76bef2536ae46121079229e4578600e64a518ff2
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -12,8 +12,7 @@ jobs:
         python-version: 3.8
     - name: Install dependencies
       run: |
-        pip install -e .[examples,examples_unix]
-        pip install sphinx-gallery sphinx_bootstrap_theme numpydoc
+        pip install -e .[docs,examples,examples_unix]
     - name: Make docs
       run: |
         cd doc

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -260,14 +260,9 @@ The resulting HTML files will be placed in ``build/html/`` and are viewable in
 a web browser. See the ``README`` file in the ``doc/`` directory for more
 information.
 
-For building the documentation, you will need
-[sphinx](http://sphinx.pocoo.org/),
-[sphinx-bootstrap-theme](https://ryan-roemer.github.io/sphinx-bootstrap-theme/),
-[sphinx-gallery](https://sphinx-gallery.github.io/)
-and
-[numpydoc](https://numpydoc.readthedocs.io/en/latest/).
+For building the documentation, you will need to install a few additional dependencies:
 ```bash
-$ pip install sphinx sphinx-bootstrap-theme sphinx-gallery numpydoc
+$ pip install -e .[docs]
 ```
 When dependencies are installed, run
 ```bash

diff --git a/setup.py b/setup.py
@@ -81,7 +81,8 @@
             "ipykernel",
             "seaborn",
         ],
-        "examples_unix": ["fanova",],
+        "examples_unix": ["fanova"],
+        "docs": ["sphinx", "sphinx-gallery", "sphinx_bootstrap_theme", "numpydoc"],
     },
     test_suite="pytest",
     classifiers=[