read-the-docs

sphinx-autoapi fails to combine class and __init__ docstrings (autoapi_python_class_content = 'both') Question: sphinx-autoapi allows to combine the class docstrings and the __init__ docstrings using the autoapi_python_class_content = ‘both’ option. However, even with this option set (conf.py), it fails to properly combine the docstrings: The class SingleOutputEcospold2Importer class SingleOutputEcospold2Importer(LCIImporter): """ Class for importing single-output ecospold2 format …

Python code blocks not rendering with readthedocs and sphinx Question: I’m building docs for a python project using Sphinx and readthedocs. For some reason, the code blocks aren’t rendering after building the docs, and inline code (marked with backticks) appears italic. I’ve checked the raw build, there was a warning that the exomagpy module couldn’t …

How can I use automodule or autoclass for Sphinx in a markdown file? Question: I understand the Sphinx supports markdown or .md files optionally, which works great for me for my supplimental documentation. What I am trying to do is use the autoclass or automodule tags in a markdown file. Normally, in a .rst file, …