Simplify template maintenance generating docs using nwb-docutils

README.md

@@ -11,10 +11,10 @@ MATLAB support is in development.
 
 ## Getting started
 
-1. Install [cookiecutter](https://pypi.org/project/cookiecutter/), a Python-based
-command-line utility that creates projects from templates:
+1. Install [cookiecutter](https://pypi.org/project/cookiecutter/) and [nwb-docutils](https://pypi.org/project/nwb-docutils/).
+`cookiecutter` is a Python-based command-line utility that creates projects from templates.
 ```bash
-python -m pip install cookiecutter
+python -m pip install cookiecutter "nwb-docutils>=0.3.1"
 ```
 2. Run cookiecutter on your local working directory:
 ```bash

azure-pipelines.yml

@@ -41,11 +41,12 @@ jobs:
   - script: |
       python -m pip install --upgrade pip
       python -m pip install --upgrade setuptools
-      python -m pip install cookiecutter
+      python -m pip install cookiecutter "nwb-docutils>=0.3.1"
     displayName: 'Install build dependencies'
 
   - bash: |
       python -m cookiecutter --no-input --output-dir "$(Agent.BuildDirectory)" "$(Build.SourcesDirectory)"
+      python tests/test_template_evaluation.py "$(Build.BuildDirectory)/ndx-my-namespace/"
     displayName: 'Evaluate template'
 
 

hooks/post_gen_project.py

@@ -2,6 +2,8 @@
 import shutil
 import textwrap
 
+from nwb_docutils.init_sphinx_extension_doc import main as init_sphinx_extension_doc
+
 
 def _select_dev_language():
     dev_language = '{{ cookiecutter.dev_language }}'
@@ -11,11 +13,29 @@ def _select_dev_language():
         shutil.rmtree(os.path.join(os.getcwd(), 'src', 'matnwb'))
 
 
+def _generate_doc():
+    init_sphinx_extension_doc([
+        "--project", "{{ cookiecutter.namespace }}",
+        "--author", "{{ cookiecutter.author }}",
+        "--version", "{{ cookiecutter.version }}",
+        "--release", "{{ cookiecutter.release }}",
+        "--output", "docs",
+        "--spec_dir", "spec",
+        "--namespace_filename", "{{ cookiecutter.namespace }}.namespace.yaml",
+        "--default_namespace", "{{ cookiecutter.namespace }}",
+        "--custom_description", "description.rst",
+        "--custom_release_notes", "release_notes.rst",
+    ])
+
+
 def main():
     """
     Runs the post gen project hook main entry point.
     """
+
     _select_dev_language()
+    _generate_doc()
+
     print(textwrap.dedent(
         """
         Success! Directory {{ cookiecutter.namespace }} was created with a skeleton for your new NWB:N extension.

tests/test_template_evaluation.py

@@ -0,0 +1,26 @@
+
+import os
+import sys
+
+
+def test_post_gen_project_hook(project_dir):
+    for expected_file in [
+        # Generated using init_sphinx_extension_doc
+        "docs/Makefile",
+        "docs/README.md",
+        "docs/make.bat",
+        "docs/source/_static/theme_overrides.css",
+        "docs/source/conf.py",
+        "docs/source/conf_doc_autogen.py",
+        "docs/source/credits.rst",
+        "docs/source/description.rst",
+        "docs/source/format.rst",
+        "docs/source/index.rst",
+        "docs/source/release_notes.rst",
+    ]:
+        expected_file = os.path.join(project_dir, expected_file)
+        assert os.path.exists(expected_file)
+
+
+if __name__ == "__main__":
+    test_post_gen_project_hook(sys.argv[1])