I now have exactly the problem that was described in this issue: https://github.com/sphinx-doc/sphinx/issues/7734. An MWE is also provided in that iss ...
I now have exactly the problem that was described in this issue: https://github.com/sphinx-doc/sphinx/issues/7734. An MWE is also provided in that iss ...
I am using Sphinx 4.4.0 with napoleon extension (Google Doc String). I have this two problems ARNING: Block quote ends without a blank line; unexp ...
I'm doing a really simple example and can't get it to work. I just have one file, simulator.py that I added numpy style docstrings to. It does not imp ...
So I've been working on some docs for some weeks now and they always appeared fine until last night all the variables started coming up in the format ...
I'd like to use the latex algpseudocode package to add algorithms to my docstrings. I'd also like to be able to define user macros to speed up my math ...
I have a project with some functions documented in the napoleon numpy style. In the spirit of numpyness, I have a bunch of function arguments that are ...
I have an open source package with lots of classes over different submodules. All classes have methods fit and transform, and inherit fit_transform fr ...
I am trying to document a Python class that has some class-level member variables, but I could not get it appropriately documented using reST/Sphinx. ...
I have a docstring in the beginning of every module describing its usage and functionality. Here I also want to add the most relevant parameters - lik ...
I noticed a change in behavior in how Sphinx renders class descriptions. Given this code # my example happens to be a dataclass, but the behavior for ...
Let's consider the following function: def f(x: int, y: int) -> int: """Get sum of two integers. Parameters ---------- x : int ...
I am using Sphinx to document one of my projects and one of the classes takes in a function as a parameter in its __init__. Is there a standard way to ...
Using sphinx 3.1.1, I want to insert an image using the napoleon pre-processor. It seems that by having the command: ".. image::" in the docstring, i ...
I'm learning how to use Sphinx to create a documentation for my code. After I saw some examples like this: def complex(real=0.0, imag=0.0): """Fo ...
I have some helper functions that, except for the first argument, take the same arguments as the core function. The parameters are thoroughly document ...
If I take the very simple python file: def magic_function(parameter1): """ Do magic with parameter1. :param parameter1: The first of all ...
I'm using Sphinx to document a python project. I would like to use Markdown in my docstrings to format them. Even if I use the recommonmark extension, ...
I have a module mod with some submodule submod and use .. automodule:: mod.submod to generate documentation for it. The signatures of the elements (f ...
I am writing documentation for my function using napoleon syntax. I would like to have a paragraph after my parameter list in the docs. The docs curre ...
I am aware of the syntax used to build a docstring for Google style such as: However, what if I have a function that can return multiple types depe ...