Remove docs from minimum profile

Introduces a question AddLocalDocumentation to control the existence of
the `docs` folder.

If the user selects "Online documentation", then "Local documentation"
is implied. The logic behind this approach is simply to define the
computed variable `AddLocalDocumentation` based on either flag.
The downside is that the generated answers will still only show the
online flag.

Related to #593

Author: abelsiqueira

CHANGELOG.md

@@ -15,6 +15,7 @@
 * Make SonarCloud optional [#515](https://github.com/NLeSC/python-template/pull/515)
 * Make citation optional [#471](https://github.com/NLeSC/python-template/pull/471)
 * Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
+* Make local documentation optional [#593](https://github.com/NLeSC/python-template/pull/593)
 
 ### Changed
 * Update the user documentation (README.md) of the template [#575](https://github.com/NLeSC/python-template/pull/623)

copier/questions/features_documentation.yml

@@ -7,13 +7,16 @@ SelectDocumentationFeatures:
   type: yaml
   default: |-
     {% if template_profile == 'recommended' %}
-      [AddOnlineDocumentation_flag, AddDevDoc_flag]
+      [AddLocalDocumentation_flag, AddOnlineDocumentation_flag, AddDevDoc_flag]
     {%- else -%}
       []
     {%- endif %}
   help: Select documentation features
   multiselect: true
   choices:
+    Local documentation:
+      value: AddLocalDocumentation_flag
+      # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
     Online documentation (Read the Docs):
       value: AddOnlineDocumentation_flag
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
@@ -22,6 +25,10 @@ SelectDocumentationFeatures:
       # validator: "{% if something != 'AnotherThing' %}BlaBla{% endif %}"
 
 # computed features
+AddLocalDocumentation:
+  type: bool
+  default: "{{ 'AddLocalDocumentation_flag' in SelectDocumentationFeatures or 'AddOnlineDocumentation_flag' in SelectDocumentationFeatures }}"
+  when: false
 AddOnlineDocumentation:
   type: bool
   default: "{{ 'AddOnlineDocumentation_flag' in SelectDocumentationFeatures }}"

template/project_setup.md.jinja

@@ -48,6 +48,7 @@ help you decide which tool to use for packaging.
   - Workflows can be found in [`.github/workflows`](.github/workflows/)
 - [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=testing)
 
+{% if AddLocalDocumentation -%}
 ## Documentation
 
 - Documentation should be put in the [`docs/`](docs/) directory. The contents have been generated using `sphinx-quickstart` (Sphinx version 1.6.5).
@@ -59,6 +60,7 @@ help you decide which tool to use for packaging.
 - [AutoAPI](https://sphinx-autoapi.readthedocs.io/) is used to generate documentation for the package Python objects.
 {% if AddOnlineDocumentation %}- `.readthedocs.yaml` is the ReadTheDocs configuration file. When ReadTheDocs is building the documentation this package and its development dependencies are installed so the API reference can be rendered.{% endif -%}
 - [Relevant section in the guide](https://guide.esciencecenter.nl/#/best_practices/language_guides/python?id=writingdocumentation)
+{%- endif %}
 
 ## Coding style conventions and code quality
 

template/pyproject.toml.jinja

@@ -55,12 +55,14 @@ dev = [
     "tox",
     "myst_parser",
 ]
+{%- if AddLocalDocumentation %}
 docs = [
     "sphinx",
     "sphinx_rtd_theme",
     "sphinx-autoapi",
     "myst_parser",
 ]
+{%- endif %}
 publishing = [
     "build",
     "twine",
@@ -97,7 +99,9 @@ extras = dev
 [tool.ruff]
 line-length = 120
 output-format = "concise"
+{%- if AddLocalDocumentation %}
 extend-exclude = ["docs"]
+{%- endif %}
 
 [tool.ruff.lint]
 # Allow unused variables when underscore-prefixed.
@@ -149,5 +153,7 @@ filename = "pyproject.toml"
 filename = "CITATION.cff"
 {%- endif %}
 
+{% if AddLocalDocumentation -%}
 [[tool.bumpversion.files]]
 filename = "docs/conf.py"
+{%- endif %}