In this post, we will see how to resolve 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 ...
In this post, we will see how to resolve How to update ReadTheDocs Project Name and URL Question: I’m working on a Python package where we decided to update the package’s name after an initial release of the package and ...
In this post, we will see how to resolve Question about installation for Readthedocs and a related question about using markdown with the Sphinx for a RTD site Question: Please bear with me as I am a tech writer, not ...
In this post, we will see how to resolve How to remove “Built with Sphinx using a theme provided by Read the Docs.” from RTD theme built docs? Question: How can I remove the sentence that’s shown underneath each page ...
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 ...
Question: I can build the docs completely fine on my computer and open the HTML result and it looks great, but when I push to GitHub and read-the-docs tried to build it- I get the following error: root file /home/docs/checkouts/readthedocs.org/user_builds/cry-vs-py/checkouts/latest/docs/index.rst ...
Question: I have a Sphinxdoc page on readthedocs with a large number (>1000) of hierarchically sorted pages, https://iraf.readthedocs.io/en/latest/tasks/index.html. My problem is now that I also need to access them in a “flat” structure, i.e. https://iraf.readthedocs.io/en/latest/tasks/addstar.html should redirect to https://iraf.readthedocs.io/en/latest/tasks/noao/digiphot/daophot/addstar.html How ...