doc path renamed to "api"

.flake8

@@ -14,7 +14,7 @@ exclude =
     dist,
     .conda,
     tests/autogenerated_*,
-    docs/source/_autogenerated
+    docs/source/api
     .venv,
     venv
 

.github/workflows/docs.yml

@@ -41,6 +41,8 @@ jobs:
           rm ./source/*.rst
           make html
           touch ./build/html/.nojekyll
+          mkdir -p ./build/html/_autogenerated
+          cp ./build/html/api/* ./build/html/_autogenerated/
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -9,7 +9,7 @@ __pycache__
 .pytest_cache
 tests/autogenerated_*.py
 docs/build/
-docs/source/_autogenerated/
+docs/source/api/
 venv/
 .venv/
 thermo_data/combined_data.yaml

docs/source/generate_class_list.py

@@ -27,7 +27,7 @@ def write_classes(f: TextIOWrapper, patterns: list[str], module_name: str, title
     write_dochtree(f, title, classes)
 
     for cls in classes:
-        with open(f'docs/source/_autogenerated/{cls}.md', 'w') as f2:
+        with open(f'docs/source/api/{cls}.md', 'w') as f2:
             f2.write(f'# {module_name}.{cls}\n')
             f2.write('```{eval-rst}\n')
             f2.write(f'.. autoclass:: {module_name}.{cls}\n')
@@ -43,7 +43,7 @@ def write_functions(f: TextIOWrapper, patterns: list[str], module_name: str, tit
     module = importlib.import_module(module_name)
 
     functions = [
-        name for name, obj in inspect.getmembers(module, inspect.isfunction)
+        name for name, _ in inspect.getmembers(module, inspect.isfunction)
         if (any(fnmatch.fnmatch(name, pat) for pat in patterns if pat not in exclude))
     ]
 
@@ -54,7 +54,7 @@ def write_functions(f: TextIOWrapper, patterns: list[str], module_name: str, tit
 
     for func in functions:
         if not func.startswith('_'):
-            with open(f'docs/source/_autogenerated/{func}.md', 'w') as f2:
+            with open(f'docs/source/api/{func}.md', 'w') as f2:
                 f2.write(f'# {module_name}.{func}\n')
                 f2.write('```{eval-rst}\n')
                 f2.write(f'.. autofunction:: {module_name}.{func}\n')
@@ -74,9 +74,9 @@ def write_dochtree(f: TextIOWrapper, title: str, items: list[str]):
 
 if __name__ == "__main__":
     # Ensure the output directory exists
-    os.makedirs('docs/source/_autogenerated', exist_ok=True)
+    os.makedirs('docs/source/api', exist_ok=True)
 
-    with open('docs/source/_autogenerated/index.md', 'w') as f:
+    with open('docs/source/api/index.md', 'w') as f:
         f.write('# Classes and functions\n\n')
 
         write_classes(f, ['*'], 'gaspype', title='Classes')

docs/source/index.md

@@ -1,8 +1,8 @@
 ```{toctree}
 :maxdepth: 1
 :hidden:
-_autogenerated/index
-_autogenerated/examples
+api/index
+api/examples
 ```
 
 ```{include} ../../README.md

docs/source/render_examples.py

@@ -51,7 +51,7 @@ def render_examples(filter: str, example_file: str):
         f.write('## Download Jupyter Notebooks\n\n')
         for path, name in zip(files, names):
             if name.lower() != 'readme':
-                run_rendering(path, 'docs/source/_autogenerated')
+                run_rendering(path, 'docs/source/api')
                 notebook = name + '.ipynb'
                 f.write(f'- [{notebook}]({notebook})\n\n')
 
@@ -63,4 +63,4 @@ def render_examples(filter: str, example_file: str):
 
 
 if __name__ == "__main__":
-    render_examples('examples/*.md', 'docs/source/_autogenerated/examples.md')
+    render_examples('examples/*.md', 'docs/source/api/examples.md')

examples/README.md

@@ -11,11 +11,11 @@ The conversion is done like the following automated by the
 [docs/source/render_examples.py](../docs/source/render_examples.py) script:
 ``` bash
 # Converting markdown with code sections to Jupyter Notebook and run it:
-notedown examples/soec_methane.md --to notebook --output docs/source/_autogenerated/soec_methane.ipynb --run
+notedown examples/soec_methane.md --to notebook --output docs/source/api/soec_methane.ipynb --run
 
 # Converting the Jupyter Notebook to Markdown and a folder with image
-# files placed in docs/source/_autogenerated/:
-jupyter nbconvert --to markdown docs/source/_autogenerated/soec_methane.ipynb --output soec_methane.md
+# files placed in docs/source/api/:
+jupyter nbconvert --to markdown docs/source/api/soec_methane.ipynb --output soec_methane.md
 ```
 
 A new example Markdown file can be created from a Jupyter Notebook running