Skip to content

Commit

Permalink
Update mkdocs.yml to include docs folder in nav section and add…
Browse files Browse the repository at this point in the history
… 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
  • Loading branch information
Jordan-Pierce committed Dec 3, 2024
1 parent 2d9b93a commit e28bfbe
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit e28bfbe

Please sign in to comment.