Closed
Description
Description of the bug
Hello, I'm trying to display some members of a module in a specific order. For that, I have the following block in my Markdown file:
::: mymodule
options:
members:
- my_func
- MyData
The documentation on the members option says:
The members will be rendered in the specified order, regardless of the value of
members_order. [source]
But when rendering the page with mkdocs, the member MyData is displayed first:
To Reproduce
I have compiled a MRE example and attached it as a zip file above. The contents are as follows:
test
├── docs
│ └── index.md
├── mkdocs.yml
├── mymodule
│ └── __init__.py
└── requirements.txt
1. Download it and extract the files
2. Run `cd test`
3. Run `pip install -r requirements.txt`
4. Run `mkdocs serve`
5. Open http://127.0.0.1:8000/ in a browser
6. You should see the same result as in the screenshot above
Full traceback
n/a
Expected behavior
I would expected that mymodule.my_func is displayed first.
Environment information
python -m mkdocstrings_handlers.python.debug # | xclip -selection clipboard- System: Linux-5.15.133.1-microsoft-standard-WSL2-x86_64-with-glibc2.35
- Python: cpython 3.11.5
- Environment variables:
- Installed packages:
mkdocsv1.5.3mkdocstringsv0.24.0mkdocstrings-pythonv1.7.5griffev0.38.1
Additional context
n/a