From e28bfbe225199bc5ebcc7cfb5bdb5ebfe6a1708b Mon Sep 17 00:00:00 2001 From: Jordan Pierce <115024024+Jordan-Pierce@users.noreply.github.com> Date: Tue, 3 Dec 2024 18:12:09 +0000 Subject: [PATCH] Update `mkdocs.yml` to include `docs` folder in `nav` section and add plugins * Add `docs` folder to `nav` section to include all markdown files * Add `mkdocs-jupyter` plugin to `plugins` section * Remove commented-out `pdf-export` plugin --- mkdocs.yml | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 6f5d90c7..599c559b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,7 +43,6 @@ plugins: - git-revision-date-localized: enable_creation_date: true type: timeago - # - pdf-export - mkdocs-jupyter: include_source: True ignore_h1_titles: True @@ -72,15 +71,15 @@ markdown_extensions: # property: UA-XXXXXXXXX-X nav: - - Home: index.md - - Installation: installation.md - - Usage: usage.md - - Contributing: contributing.md - - FAQ: faq.md - - Changelog: changelog.md + - Home: docs/index.md + - Installation: docs/installation.md + - Usage: docs/usage.md + - Contributing: docs/contributing.md + - FAQ: docs/faq.md + - Changelog: docs/changelog.md - Report Issues: https://github.com/Jordan-Pierce/CoralNet-Toolbox/issues - Examples: - - examples/intro.ipynb + - docs/examples/intro.ipynb - API Reference: - - coralnet_toolbox module: coralnet_toolbox.md - - common module: common.md + - coralnet_toolbox module: docs/coralnet_toolbox.md + - common module: docs/common.md