I've disabled the markdown support because it messes with the rst code blocks and numbered lists. You can find examples on this page when you compile the docs:
https://i2mint.github.io/epythet/module_docs/epythet.html
This code needs to change
epythet/_static/docsrc/conf.py
import commonmark
def docstring(app, what, name, obj, options, lines):
md = '\n'.join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
def setup(app):
app.connect('autodoc-process-docstring', docstring)
The markdown parser should not be blindly applied to the entire document.
One possible solution is to have some kind of sentinel or keyword show where md starts and finishes and only apply it to those sections. Even better if you can tell the difference between md and rst without the users knowledge.
Documentation must be added for whatever the solution ends up being.
I've disabled the markdown support because it messes with the rst code blocks and numbered lists. You can find examples on this page when you compile the docs:
https://i2mint.github.io/epythet/module_docs/epythet.html
This code needs to change
epythet/_static/docsrc/conf.pyThe markdown parser should not be blindly applied to the entire document.
One possible solution is to have some kind of sentinel or keyword show where md starts and finishes and only apply it to those sections. Even better if you can tell the difference between md and rst without the users knowledge.
Documentation must be added for whatever the solution ends up being.