How to get the "mod", "class", "attr"... notations?

[NahuelCostaCortez]

By default, when using mkdocstrings with the literate navigation file the documentation is displayed as in the gif shown at the beginning of the readme of this repo:

However, at https://mkdocstrings.github.io/reference/ one can see the type of each folder/file and the modules/classes/functions are also described at the top of each page:

Here the differences can be easily seen.

So my question is how can that be achieved? Sorry in advance if this is already published somewhere else but I have not found anything.

Thanks,
Nahuel

[pawamoy]

You're looking for the show_symbol_type_heading and show_symbol_type_toc options 🙂

• https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_heading
• https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc

[NahuelCostaCortez]

Thank you for the prompt reply! I see it is already included in the mkdocs.yml of this repo, however, I cloned it and when executing mkdocs serve it is not displayed like that. I am wondering if it has to do with any package installation I´m missing. To make it work I installed the following:

pip install mkdocs-coverage
pip install mkdocs-git-committers-plugin
pip install mkdocs-techdocs-redirects
pip install mkdocs-minify-plugin
pip install markdown-callouts

Not sure it this is the best way to reproduce the web shown in https://mkdocstrings.github.io/reference/ but I did not see any requirements.txt.

Thank you in advance!

[pawamoy]

Seems to lack pip install mkdocstrings-python? Though without it you'd get an error. It needs mkdocstrings-python>=1.8.0.

You can also do this:

pip install mkdocs
pip install $(mkdocs get-deps)

...to make sure you get all MkDocs plugins and Markdown extensions.

[NahuelCostaCortez]

Yeah, sorry I missed the pip install mkdocstrings-python in my previous response. With pip install $(mkdocs get-deps) now it works so it must depend on some other extension I guess.

Thanks for your help.