lincc-frameworks · delucchi-cmu · Jun 12, 2023 · Jun 9, 2023 · Jun 9, 2023 · Jun 9, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -64,6 +64,15 @@ jobs:
               --data include_notebooks=no
               --data use_gitlfs=disabled
             foldername: 'pylint_w_o_example_module'
+          - name: No sphinx docs
+            package_name: 'drewtonian'
+            extra_flags: >-
+              --data project_name=new_science
+              --data package_name=drewtonian
+              --data include_docs=no
+              --data include_notebooks=no
+            foldername: 'no_sphinx_docs'
+
     steps:
 
     - name: Checkout code
@@ -125,6 +134,7 @@ jobs:
         cat ../test/${{ matrix.copier_config.foldername }}/docs/requirements.txt
 
     - name: Build docs
+      if: ${{ !contains(matrix.copier_config.extra_flags, 'include_docs=no') }}
       run: |
         cd ../test/${{ matrix.copier_config.foldername }}
         sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html

diff --git a/copier.yml b/copier.yml
@@ -81,14 +81,23 @@ create_example_module:
         no: false
     when: "{{ custom_install }}"
 
+include_docs:
+    help: Do you want to include a directory for sphinx, and autoapi generation?
+    type: bool
+    default: yes
+    choices:
+        yes: true
+        no: false
+    when: "{{ custom_install }}"
+
 include_notebooks:
     help: Do you want to include rendered notebooks in your documentation?
     type: bool
     default: yes
     choices:
         yes: true
         no: false
-    when: "{{ custom_install }}"
+    when: "{{ custom_install and include_docs }}"
 
 use_gitlfs:
     help: Do you want to add a .gitattributes with entries for git-lfs (see https://lincc-ppt.readthedocs.io/en/latest/practices/git-lfs.html)?

diff --git a/...b/workflows/build-documentation.yml.jinja → ...}build-documentation.yml{% endif %}.jinja b/...b/workflows/build-documentation.yml.jinja → ...}build-documentation.yml{% endif %}.jinja
diff --git a/python-project-template/.pre-commit-config.yaml.jinja b/python-project-template/.pre-commit-config.yaml.jinja
@@ -158,7 +158,7 @@ repos:
             "-D", # Flag to override settings in conf.py
             "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit
           ]
-{%- else %}
+{%- elif include_docs %}
     # Make sure Sphinx can build the documentation without issues.
   - repo: local
     hooks:

diff --git a/python-project-template/pyproject.toml.jinja b/python-project-template/pyproject.toml.jinja
@@ -19,7 +19,9 @@ classifiers = [
 ]
 dynamic = ["version"]
 dependencies = [
+{%- if include_notebooks %}
     "ipykernel", # Support for Jupyter notebooks
+{%- endif %}
 ]
 
 # On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)
@@ -28,9 +30,11 @@ dev = [
     "pytest",
     "pytest-cov", # Used to report total code coverage
     "pre-commit", # Used to run checks before finalizing a git commit
+{%- if include_docs %}
     "sphinx==6.1.3", # Used to automatically generate documentation
     "sphinx-rtd-theme==1.2.0", # Used to render documentation
     "sphinx-autoapi==2.0.1", # Used to automatically generate api documentation
+{%- endif %}
 {%- if preferred_linter == 'pylint' %}
     "pylint", # Used for static linting of files
 {%- elif preferred_linter == 'black' %}

diff --git a/python-project-template/.readthedocs.yml → ...nclude_docs %}.readthedocs.yml{% endif %} b/python-project-template/.readthedocs.yml → ...nclude_docs %}.readthedocs.yml{% endif %}
diff --git a/python-project-template/docs/Makefile.jinja → ...ude_docs %}docs{% endif %}/Makefile.jinja b/python-project-template/docs/Makefile.jinja → ...ude_docs %}docs{% endif %}/Makefile.jinja
diff --git a/python-project-template/docs/conf.py.jinja → ...lude_docs %}docs{% endif %}/conf.py.jinja b/python-project-template/docs/conf.py.jinja → ...lude_docs %}docs{% endif %}/conf.py.jinja
diff --git a/python-project-template/docs/index.rst.jinja → ...de_docs %}docs{% endif %}/index.rst.jinja b/python-project-template/docs/index.rst.jinja → ...de_docs %}docs{% endif %}/index.rst.jinja
diff --git a/...project-template/docs/notebooks/README.md → ...ocs %}docs{% endif %}/notebooks/README.md b/...project-template/docs/notebooks/README.md → ...ocs %}docs{% endif %}/notebooks/README.md
diff --git a/...tebooks %}intro_notebook.ipynb{% endif %} → ...tebooks %}intro_notebook.ipynb{% endif %} b/...tebooks %}intro_notebook.ipynb{% endif %} → ...tebooks %}intro_notebook.ipynb{% endif %}
diff --git a/...ject-template/docs/requirements.txt.jinja → ... %}docs{% endif %}/requirements.txt.jinja b/...ject-template/docs/requirements.txt.jinja → ... %}docs{% endif %}/requirements.txt.jinja
diff --git a/...lude_notebooks %}notebooks.rst{% endif %} → ...lude_notebooks %}notebooks.rst{% endif %} b/...lude_notebooks %}notebooks.rst{% endif %} → ...lude_notebooks %}notebooks.rst{% endif %}