-
Hi Patrick,
I wanted to check if my docstrings look good in the documentation :)
So I tried running `mkdocs serve` and I got the following error:
```python
raise AliasResolutionError(se…
-
CC @rahulporuri
1) I'd recommend switching to the mkdocs-material theme, which is far more usable and legible. Eg: https://listmonk.app/docs - Ref: https://github.com/knadh/listmonk/blob/master/doc…
knadh updated
1 month ago
-
### Overview
We need the Engineering documentation to be using mkdocs so that we can easily copy sections from the website or our docs over to it when needed.
The idea is to move generally-useful en…
fyliu updated
2 months ago
-
### Description of the bug
In the [jinja template](https://github.com/mkdocstrings/griffe-pydantic/tree/main/src/griffe_pydantic/templates/material/_base), in the config section we iterate throught…
-
Currently, in the template the documentation is generated using Sphinx. However, [MkDocs](https://www.mkdocs.org/) offers a more modern and streamlined approach to documentation generation that co…
-
Extra note: Make sure to add flowcharts for test states such as `lvstartup`
-
I found a possible bug,
here is the stack trace:
```
ERROR - Error reading page 'software/hermes/api.md': 'list' object has no attribute 'get'
Traceback (most recent call last):
File "/o…
-
Does not seem to work on `mkdocs-typedoc`, it just skips that page and does all the other pages.
-
Hi @timvink
We have an extensive set of documentation with various hierarchical levels.. Please review the following concerns and provide your suggestions.
### **Issues with Table of Contents …
-
This thing: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=versio#stay-on-the-same-page-when-switching-versions
This doesn't work – most likely because we've set site_ur…