search

jcayers20 / mkdocs-autoapi

MkDocs plugin providing automatic API reference generation
MIT License
2 stars 0 forks source link

Feature request ideas #5

Open cdwilson opened 2 months ago

cdwilson commented 2 months ago

Hey @jcayers20 I'm currently playing around with a recipe script for generating the API docs (see https://github.com/mkdocstrings/mkdocstrings/discussions/687 for more details). The main things it adds which this plugin doesn't currently do:

  1. Adds the ability to show/hide [mod] tags in the left nav and footer nav
  2. Adds the ability to control whether the full object path is shown in the left nav and footer nav

Not sure if you're looking for feature requests 😁, but if you are, these would be nice to have.

FYI, I also ended up using mkdocs-awesome-pages-plugin (instead of mkdocs-literate-nav and mkdocs-section-index) due to some issues I noticed with those plugins (and the fact that I can use awesome-pages for the manual docs as well).

jcayers20 commented 2 months ago

I'm absolutely open to feature requests :smile:

I'll take a closer look at the links you provided and see what I can do about getting these implemented!