#154 updated build command

README.md

@@ -120,7 +120,7 @@ _build/html/homepage.html
 2. You can also build the documentation by automatically triggering a build after every change to the source files, providing a "live" preview of changes. To trigger the automated builds, run [`sphinx-autobuild`](https://github.com/executablebooks/sphinx-autobuild) from the repository root directory:
 
 ```bash
-sphinx-autobuild source _build/html -a -j auto --open-browser
+sphinx-autobuild source _build/html -a -j auto --ignore source/content/api* --open-browser
 ```
 
 | positional argument or option| value | description |
@@ -129,6 +129,7 @@ sphinx-autobuild source _build/html -a -j auto --open-browser
 | outdir | `_build/html` | N/A |
 | `-a` | N/A | always write all output files |
 | `-j` | `auto` | [speed up build by using multiple processes](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-j) |
+| `--ignore` | `source/content/api*` | ignores API documentation generated with sphinx-autoapi to avoid infinite build loops |
 | `--open-browser` | N/A | automatically open browser |
 
 

source/conf.py

@@ -49,7 +49,10 @@
 root_doc = 'index'
 html_static_path = ['_static']
 templates_path = ['_templates']
-exclude_patterns = ['_build']
+exclude_patterns = [
+    '_build',
+    'source/content/api/*'
+]
 html_theme = "pydata_sphinx_theme"
 
 suppress_warnings = [
@@ -205,7 +208,7 @@
 autoapi_python_class_content = 'both'
 autoapi_member_order = 'groupwise'
 autoapi_root = 'content/api'
-autoapi_keep_files = False
+autoapi_keep_files = True
 
 # myst_parser Configuration ############################################
 # https://myst-parser.readthedocs.io/en/latest/configuration.html