We can indicate the types of function parameters using docstring in python: def f1(a): """ :param a: an input. :type a: int :return: the input integer. :rtype: int """ return a For f1, au...

I've spent quite a while scouring the internet looking for the best way to properly document callbacks with jsdoc, but unfortunately, I haven't found a great one yet. Here's my question: I'm writ...

I have a three-layered class structure like this: class Super(object): """This class is documented.""" class Intermediate(Super): pass class Sub(Intermediate): """This is also documented.""" ...

I'm trying to get started with Sphinx and seem to have relentless problems. Command: docs/sphinx-quickstart I answer all the questions and everything works fine. Command: docs/ls Everything looks n...

I'm trying to use Sphinx to document a 5,000+ line project in Python. It has about 7 base modules. As far as I know, In order to use autodoc I need to write code like this for each file in my proje...

I've got some code that uses a metaclass in python. But when sphinx autodoc is run it is giving the error: WARNING: py:class reference target not found: type The error is occuring in a line of an...

The following two property definitions show up exactly the same in Sphinx autodoc HTML output: @property def concrete(self): """This is the concrete docstring""" pass @abstractproperty def abst...

I'm currently writing documentation for my python package using Sphinx and the autodoc plugin. For a function return value I can e.g. write :returns: int: count which tells sphinx that there is a ...

I'm trying to document a project using Sphinx, and am running into an issue where only some modules are being imported from a folder. My project structure looks like this: Project | |--Main | |--S...

I'd like to include just the docstring of a specific function in my Sphinx documentation. However there seem to be no options to just display these details without associated class and function def...

I am documenting a class with Sphinx and simple want to skip one of the classes members: class StatusUpdateAdapter(logging.LoggerAdapter): """ """ def __init__(self, status_update_func, logger,...

Given the following function in a module called mymodule that I want to document using Sphinx with autodoc: from typing import Union from collections.abc import Iterable from numpy.typing import Ar...

I am attempting to use Sphinx to document my Python class. I do so using autodoc: .. autoclass:: Bus :members: While it correctly fetches the docstrings for my methods, those that are decorated...

I have a question regarding the Sphinx autodoc generation. I feel that what I am trying to do should be very simple, but for some reason, it won't work. I have a Python project of which the directo...

As this post describes, autodoc will eagerly add the class variables to the documentation even if napoleon adds the fields as documentation in: from dataclasses import dataclass @dataclass class Fo...

Currently, I have some code that uses mypy type annotations like this: def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'): # type: (Translator, str, bool, ...

I am using Sphinx for documenting my python project. I have the autodoc extension enabled and have the following in my docs. .. autoclass:: ClassName :members: The problem is, it only documents...

I'm using sphinx with the numpydoc extension and autosummary. After some experimentation, I added the following options to my conf.py file. autosummary_generate = True numpydoc_show_class_members ...

I am using the Sphinx autodoc feature to generate documentation based on the docstrings of my Python library. The syntax for cross referencing is found here A label must precede the section in or...

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 ma...

I've been working on a project for PyQt5 ( found here: https://github.com/MaVCArt/StyledPyQt5 ) which uses a package structure to make imports a bit more logical. I've been relatively successful in...

I want to autogenerate documentation to my code from docstrings. I have some basic class meant to store some data: class DataHolder: """ Class to hold some data Attributes: batch: Run withou...

Sphinx doesn't generate docs for __init__(self) by default. I have tried the following: .. automodule:: mymodule :members: and ..autoclass:: MyClass :members: In conf.py, setting the follow...

This question is inspired by the Mayavi documentation, which has nice section breaks with the name of the function being described between each module member. My .rst right now just looks like: SQL...

Problem I am using sphinx.ext.autosummary for my python package. The problem is that .. autosummary:: adds .. automethod:: __init__ at all times, even if undocumented. In the mean time I have found...