You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi @tomchristie! I'm finding the mkdocs ecosystem of packages to be quite a joy to use, and yours is part of it too!
I've been doing just a trial-run seeing whether we can make the PyMC4 docs from sphinx rather than mkdocs, and mkautodoc has been pretty cool. It does necessitate that I rewrite docstrings in markdown, but that's not a big issue.
One question I've got for you, just to see whether this is possible or not - do you know how we can have our classes and functions that are "top-level" defined in a module show up as part of the mkdocs-generated table of contents? In particular, I'm thinking of having them show up on the right hand side (like in the screenshot I have attached below):
At the moment, in the Markdown file, I have to do something like:
# PyMC4 Continuous Distributions
## Beta Distribution
::: pymc4.distributions.continuous.Beta
:docstring:
## Normal distribution
......
Instead, I'd like to be able to do something like:
Hi @tomchristie! I'm finding the mkdocs ecosystem of packages to be quite a joy to use, and yours is part of it too!
I've been doing just a trial-run seeing whether we can make the PyMC4 docs from sphinx rather than mkdocs, and mkautodoc has been pretty cool. It does necessitate that I rewrite docstrings in markdown, but that's not a big issue.
One question I've got for you, just to see whether this is possible or not - do you know how we can have our classes and functions that are "top-level" defined in a module show up as part of the mkdocs-generated table of contents? In particular, I'm thinking of having them show up on the right hand side (like in the screenshot I have attached below):
At the moment, in the Markdown file, I have to do something like:
Instead, I'd like to be able to do something like:
and still get the right-side TOC rendering from parsing the Markdown.
The text was updated successfully, but these errors were encountered: