Doc build update to move api to generated dir and update to gitignore (…

…#31) * moved api to generated directory * added ignore of DS_Store files * Update .gitignore to correct version file
HERMES-SOC · Aug 21, 2023 · ec7ab3a · ec7ab3a
1 parent fff5463
commit ec7ab3a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/hermes_{{ cookiecutter.instr_name }}/.gitignore b/hermes_{{ cookiecutter.instr_name }}/.gitignore
@@ -147,5 +147,8 @@ docs/_build
 docs/generated
 docs/api
 docs/whatsnew/latest_changelog.txt
-hermes_{{ cookiecutter.instr_name }}/version.py
+hermes_{{ cookiecutter.instr_name }}/_version.py
 htmlcov/
+
+# Mac hidden files
+.DS_Store
diff --git a/hermes_{{ cookiecutter.instr_name }}/docs/Makefile b/hermes_{{ cookiecutter.instr_name }}/docs/Makefile
@@ -16,7 +16,7 @@ help:
 
 clean:
 	rm -rf $(BUILDDIR)
-	rm -rf api
+	rm -rf ./generated
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/hermes_{{ cookiecutter.instr_name }}/docs/conf.py b/hermes_{{ cookiecutter.instr_name }}/docs/conf.py
@@ -42,6 +42,9 @@
     "sphinx_changelog",
 ]
 
+# Set automodapi to generate files inside the generated directory
+automodapi_toctreedirnm = "generated/api"
+
 # Set automodapi to generate files inside the generated directory
 # automodapi_toctreedirnm = "_build/html/api"
 numpydoc_show_class_members = False