Skip to content

Conversation

@ashleynilo
Copy link
Collaborator

Related Issue(s) #3452
Has Unit Tests (y/n) n
Documentation Included (y/n) n

Change Description

  • Installed mkdocs-awesome-nav plugin and added under plugins: section of mkdocs.yml
  • Moved all previous nav: links from mkdocs.yml to .nav.yml.
    • It must be in this new file for awesome-nav to recognize it.
    • It also must be located outside of the docs/ directory so that the top tabs only shows folders in docs/. Otherwise it will show ALL .md files in fprime/
    • All links for User Manual, How To, and Reference have been updated to only have the folder path. All files underneath each folder should now be auto-added with the plugin
    • To keep the order and add the external link to FPP, each folder under /user-manual is specified manually rather than having everything added at the root /user-manual level
    • Learn more about customizing the new nav here
  • Updated nav: in mkdocs.yml to only include nav list of tutorials. This allows multirepo to import the files in and have it be recognized by awesome-nav. This does not act as a real nav anymore and only serves to import multirepo docs

Rationale

  • Allows developers to add new pages and have it be automatically recognized in the navigation menus.

Testing/Review Recommendations

  • Please test and make sure it works with versioning/when redirecting to the static pages

Future Work

  • This plugin only works with Python version >=3.10. Please update python before pushing to the website

@ashleynilo ashleynilo requested a review from thomas-bc April 7, 2025 23:07
@thomas-bc thomas-bc self-assigned this Apr 22, 2025
Copy link
Collaborator

@thomas-bc thomas-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@LeStarch LeStarch merged commit 548012b into nasa:devel Apr 25, 2025
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants