File tree Expand file tree Collapse file tree 4 files changed +2
-11
lines changed
Expand file tree Collapse file tree 4 files changed +2
-11
lines changed Original file line number Diff line number Diff line change @@ -13,5 +13,4 @@ See https://oprypin.github.io/mkdocs-literate-nav/
1313 - [ Dependency pinning and testing] ( further-background/dependency-pinning-and-testing.md )
1414- [ Development] ( development.md )
1515- [ API reference] ( api/example_fgen_basic/ )
16- - [ Fortran API] ( fortran-api/example_fgen_basic/ )
1716- [ Changelog] ( changelog.md )
Original file line number Diff line number Diff line change 2727
2828# Put back the gitkeep file which ford deletes
2929(REPO_ROOT / "docs" / ROOT_DIR / ".gitkeep" ).touch ()
30-
31- # TODO: figure out why this causes the final route to go to the wrong place
32- nav [PACKAGE_NAME_ROOT ] = "index.html"
33-
34- # Temporary solution - only add index to navigation.
35- # Can get more fancy in future.
36- with mkdocs_gen_files .open (ROOT_DIR / PACKAGE_NAME_ROOT / "NAVIGATION.md" , "w" ) as fh :
37- fh .writelines (nav .build_literate_nav ())
Original file line number Diff line number Diff line change 22
33## API docs
44Our Python API is documented in [ API] [ example_fgen_basic_1 ] .
5- The Fortran API is documented in [ Fortran API] ( ./fortran-api ) .
5+ The Fortran API is documented in [ Fortran API] ( ./fortran-api/ ) .
66At present, the Fortran API docs are a sub-website so you can navigate to them
77but there are no buttons to navigate back to the main docs page
88(so you have to instead return yourself by re-entering the URL
Original file line number Diff line number Diff line change 11---
22project : Example fgen - basic
33author : TODO align this with pyproject.toml
4- output_dir : docs/fortran-api/example_fgen_basic
4+ output_dir : docs/fortran-api
55src_dir : src
66graph : true
77---
You can’t perform that action at this time.
0 commit comments