Get things building without errors

Author: znicholls

docs/NAVIGATION.md

@@ -13,5 +13,5 @@ See https://oprypin.github.io/mkdocs-literate-nav/
     - [Dependency pinning and testing](further-background/dependency-pinning-and-testing.md)
 - [Development](development.md)
 - [API reference](api/example_fgen_basic/)
-- [Fortran API](fortran-api/)
+- [Fortran API](fortran-api/example_fgen_basic/)
 - [Changelog](changelog.md)

docs/gen_fortran_api.py

@@ -8,7 +8,12 @@
 import subprocess
 from pathlib import Path
 
+import mkdocs_gen_files
+
 REPO_ROOT = Path(__file__).parents[1]
+PACKAGE_NAME_ROOT = "example_fgen_basic"
+ROOT_DIR = Path("fortran-api")
+nav = mkdocs_gen_files.Nav()
 
 ford = shutil.which("ford")
 if ford is None:
@@ -21,4 +26,12 @@
 )
 
 # Put back the gitkeep file which ford deletes
-(REPO_ROOT / "docs" / "fortran-api" / ".gitkeep").touch()
+(REPO_ROOT / "docs" / ROOT_DIR / ".gitkeep").touch()
+
+# TODO: figure out why this causes the final route to go to the wrong place
+nav[PACKAGE_NAME_ROOT] = "index.html"
+
+# Temporary solution - only add index to navigation.
+# Can get more fancy in future.
+with mkdocs_gen_files.open(ROOT_DIR / PACKAGE_NAME_ROOT / "NAVIGATION.md", "w") as fh:
+    fh.writelines(nav.build_literate_nav())

ford_config.md

@@ -1,7 +1,7 @@
 ---
 project: Example fgen - basic
 author: TODO align this with pyproject.toml
-output_dir: docs/fortran-api
+output_dir: docs/fortran-api/example_fgen_basic
 src_dir: src
 graph: true
 ---