gen-files/reference.py for the reference generation

.github/workflows/pages.yml

@@ -53,6 +53,10 @@ jobs:
         run: |
           python --version
           python -m pip list
+      - name: Set Env for tablite Import
+        uses: allenevans/[email protected]
+        with:
+          USE_NIMPORTER: false
       - name: Configure Git user
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"

.pages

@@ -6,4 +6,4 @@ nav:
     - Changelog: changelog.md
     - Benchmarks: benchmarks.ipynb
     - Tutorial: tutorial.ipynb
-  - Reference: reference.md
+  - Reference: reference # virtual folder created by gen-files plugin and reference.py

mkdocs.yml

@@ -72,6 +72,9 @@ plugins:
   - mike
   - same-dir
   - awesome-pages
+  - gen-files:
+      scripts:
+        - reference.py
 
 extra:
   version:

reference.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python
+
+import tablite
+import mkdocs_gen_files
+import pkgutil
+
+# We are generating files in the virtual mkdocs_gen_files environment, no real files are created
+for submodule in pkgutil.iter_modules(tablite.__path__):
+    with mkdocs_gen_files.open("reference/{submodule_name}.md".format(submodule_name=submodule.name), "w") as f:
+        print("::: tablite.{submodule_name}".format(submodule_name=submodule.name), file=f)

requirements_mkdocs.txt

@@ -8,3 +8,4 @@ mkdocstrings
 mkdocstrings-python
 mkdocs-same-dir
 mkdocs-awesome-pages-plugin
+mkdocs-gen-files