Skip to content

Commit 8ccfc81

Browse files
committed
Remove Fortran API from nav to simplify for now
1 parent a9a8da8 commit 8ccfc81

File tree

4 files changed

+2
-11
lines changed

4 files changed

+2
-11
lines changed

docs/NAVIGATION.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff 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)

docs/gen_fortran_api.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,3 @@
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())

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## API docs
44
Our 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/).
66
At present, the Fortran API docs are a sub-website so you can navigate to them
77
but 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

ford_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
project: Example fgen - basic
33
author: TODO align this with pyproject.toml
4-
output_dir: docs/fortran-api/example_fgen_basic
4+
output_dir: docs/fortran-api
55
src_dir: src
66
graph: true
77
---

0 commit comments

Comments
 (0)