From 938be1730b25850808058a4e665ebabcebd42f17 Mon Sep 17 00:00:00 2001
From: Sander van Rijn <s.vanrijn@esciencecenter.nl>
Date: Mon, 6 May 2024 13:24:54 +0200
Subject: [PATCH] Add extra optional-dependencies section for documentation
 requirements

---
 CHANGELOG.md                                      | 1 +
 {{cookiecutter.directory_name}}/.readthedocs.yaml | 2 +-
 {{cookiecutter.directory_name}}/README.dev.md     | 2 ++
 {{cookiecutter.directory_name}}/project_setup.md  | 2 +-
 {{cookiecutter.directory_name}}/pyproject.toml    | 6 ++++++
 5 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 949c3856..63ca6faa 100644
--- a/CHANGELOG.md
+++ b/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
 
diff --git a/{{cookiecutter.directory_name}}/.readthedocs.yaml b/{{cookiecutter.directory_name}}/.readthedocs.yaml
index 544d704c..b2a53689 100644
--- a/{{cookiecutter.directory_name}}/.readthedocs.yaml
+++ b/{{cookiecutter.directory_name}}/.readthedocs.yaml
@@ -4,4 +4,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - dev
+        - docs
diff --git a/{{cookiecutter.directory_name}}/README.dev.md b/{{cookiecutter.directory_name}}/README.dev.md
index f74dcfaa..b839f920 100644
--- a/{{cookiecutter.directory_name}}/README.dev.md
+++ b/{{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.
diff --git a/{{cookiecutter.directory_name}}/project_setup.md b/{{cookiecutter.directory_name}}/project_setup.md
index 91ce36df..3d1b196e 100644
--- a/{{cookiecutter.directory_name}}/project_setup.md
+++ b/{{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
 
diff --git a/{{cookiecutter.directory_name}}/pyproject.toml b/{{cookiecutter.directory_name}}/pyproject.toml
index 9dd96e77..1dcbc128 100644
--- a/{{cookiecutter.directory_name}}/pyproject.toml
+++ b/{{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",