Merge pull request #387 from NLeSC/317-separate-docs-dependencies

Add extra optional-dependencies section for documentation requirements

Author: sjvrijn

CHANGELOG.md

@@ -9,6 +9,7 @@
 * Docstring for function
 * Intersphinx to documentation
 * Coverage and doctest commands for documentation [#97](https://github.com/NLeSC/python-template/issues/97)
+* Added new 'docs' section in extra dependencies [#317](https://github.com/NLeSC/python-template/issues/317)
 
 ### Changed
 

{{cookiecutter.directory_name}}/.readthedocs.yaml

@@ -4,4 +4,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - dev
+        - docs

{{cookiecutter.directory_name}}/README.dev.md

@@ -19,6 +19,8 @@ python -m pip install --upgrade pip setuptools
 python -m pip install --no-cache-dir --editable .
 # install development dependencies
 python -m pip install --no-cache-dir --editable .[dev]
+# install documentation dependencies only
+python -m pip install --no-cache-dir --editable .[docs]
 ```
 
 Afterwards check that the install directory is present in the `PATH` environment variable.

{{cookiecutter.directory_name}}/project_setup.md

@@ -29,7 +29,7 @@ of the
 guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=dependencies-and-package-management).
 
 - Runtime dependencies should be added to `pyproject.toml` in the `dependencies` list under `[project]`.
-- Development dependencies should be added to `pyproject.toml` in one of the lists under `[project.optional-dependencies]`.
+- Development dependencies, such as for testing or documentation, should be added to `pyproject.toml` in one of the lists under `[project.optional-dependencies]`.
 
 ## Packaging/One command install
 

{{cookiecutter.directory_name}}/pyproject.toml

@@ -56,6 +56,12 @@ dev = [
     "tox",
     "myst_parser",
 ]
+docs = [
+    "sphinx",
+    "sphinx_rtd_theme",
+    "sphinx-autoapi",
+    "myst_parser",
+]
 publishing = [
     "build",
     "twine",