{"id":21573,"library":"mkdocs-api-autonav","title":"MkDocs API AutoNav","description":"Plugin for MkDocs that automatically generates API documentation using mkdocstrings and populates the navigation tree. Version 0.4.0 requires Python >=3.9. Active development, releases occur irregularly.","status":"active","version":"0.4.0","language":"python","source_language":"en","source_url":"https://github.com/timmeinerzhagen/mkdocs-api-autonav","tags":["mkdocs","plugin","api-docs","autonav","mkdocstrings"],"install":[{"cmd":"pip install mkdocs-api-autonav","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core framework required.","package":"mkdocs","optional":false},{"reason":"Required for API doc generation.","package":"mkdocstrings","optional":false}],"imports":[],"quickstart":{"code":"# mkdocs.yml\nplugins:\n  - search\n  - mkdocs-api-autonav:\n      modules:\n        - \"my_package\"\n\n# docs/index.md\n# Welcome to My Package\n# Full API reference is auto-generated.\n","lang":"yaml","description":"Add the plugin to your MkDocs configuration. The plugin will scan the specified modules and generate markdown pages with mkdocstrings, automatically updating the navigation."},"warnings":[{"fix":"Replace 'nav' key with 'modules' in mkdocs.yml. Example: modules: ['my_package'].","message":"Version 0.4.0 changed the configuration from 'nav' to 'modules'. Old config will be ignored silently.","severity":"breaking","affected_versions":"<=0.3.x"},{"fix":"Ensure generated directories (e.g., 'api') are not manually created or tracked in version control. Add them to .gitignore.","message":"The plugin generates files in the docs directory. If you have existing docs, they may be overwritten if names collide.","severity":"gotcha","affected_versions":"all"},{"fix":"Always use list syntax: modules: ['module1', 'module2']. Avoid quoting the whole list.","message":"The module list must be provided as a YAML list of strings. A single string will cause a cryptic error.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade Python to >=3.9 or pin to mkdocs-api-autonav==0.3.x.","message":"Support for Python 3.8 was dropped in 0.4.0. Install on Python 3.8 will fail.","severity":"deprecated","affected_versions":"<0.4.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Install the package or adjust sys.path. Ensure the module is installed in the same environment.","cause":"The module name specified in 'modules' must be importable in the Python environment where mkdocs build runs.","error":"ModuleNotFoundError: No module named 'my_template'"},{"fix":"Change to proper YAML list: modules: ['mypackage'].","cause":"In mkdocs.yml, the 'modules' value is a string instead of a list.","error":"ValueError: The plugins configuration has an invalid type. Expected a list, got a string."},{"fix":"Remove or update 'nav' key. Use 'modules' key instead.","cause":"Mixing old 'nav' style with new plugin style configuration. The plugin expects 'modules'.","error":"The \"mkdocs-api-autonav\" plugin is not compatible with the \"nav\" configuration option."}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}