diff --git a/docs/index.md b/docs/README.md similarity index 69% rename from docs/index.md rename to docs/README.md index 6e6c79f..a2e6a21 100644 --- a/docs/index.md +++ b/docs/README.md @@ -3,4 +3,4 @@ This is the generated documentation page for the template Python package for the [SECORO AG](https://www.uni-bremen.de/secoro) at Univerity of Bremen. -Also check out the generated [API documentation](references/). +Also check out the generated [API documentation](reference/python_pkg_tmpl/). diff --git a/mkdocs.yml b/mkdocs.yml index ab00744..5e8c1db 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ site_author: 'SECORO AG' repo_url: https://github.com/secorolab/python-pkg-template nav: - - Home: index.md + - Home: README.md # defer to gen-files + literate-nav - API reference: reference/ theme: