Stack Overflow
Stack Overflow

Questions tagged [autosummary]

Extension for the Sphinx documentation generator that outputs summary lists for Python objects, similar to the output from Epydoc and other API documentation tools.

Extension for the Sphinx documentation generator that outputs summary lists for Python objects, similar to the output from Epydoc and other API documentation tools.

22 questions
0
votes
0 answers

Sphinx autosummary when generating documentation for torch.nn.Module: Type object has no attribute "Training"

I have run into this issue with Sphinx autosummary when trying to let it generate documentation for a torch.nn.Module class. Minimal example: https://github.com/longyuxi/sphinx-autosummary-debug Folder structure: . ├── README.md ├── docs │   ├──…
Yuxi L
  • 46
  • 4
0
votes
0 answers

Sphinx autosummary is ignoring all custom text I try to add to my custom template

I'm trying to create a custom template for autosummary, but I can't figure out how to add any custom modifications. I'm using autosummary in an rst like this: API === .. autosummary:: :toctree: _autosummary :template: custom_test.rst.j2 …
red888
  • 27,709
  • 55
  • 204
  • 392
0
votes
0 answers

Autosummary fails to import the methods from the package classes locally

I'm trying to understand better doc-builds by working on this sandbox project: https://github.com/mscheltienne/simple-stimuli The current documentation, built by this CI, is available here:…
Mathieu
  • 5,410
  • 6
  • 28
  • 55
0
votes
0 answers

Display directly first element of Sphinx index.rst's toctree instead of a blank page

I have a Python package (https://github.com/frannerin/AlloViz)'s documentation (https://alloviz.readthedocs.io/) with the following structure: AlloViz/docs/source │ conf.py │ index.rst │ README.rst │ └───API │ index.rst │ …
Francho Nerín Fonz
  • 311
  • 2
  • 7
0
votes
0 answers

Sphinx - Specific file documentation with autosummary

I'm trying to use Sphinx's autosummary extension to generate the documentation automatically for the methods of a single file. I have the following folder structure on sphinx -docs -source -api.rst -conf.py -src -players -a.py …
Bossipo
  • 178
  • 1
  • 10
0
votes
0 answers

Sphinx unable to import some modules

I am using to generate documentation for codebase. While building the docs, I could see that they were built for some modules only and many were left undocumented with warning in console - failed to import .Even after going through…
Vineet
  • 723
  • 4
  • 12
  • 31
0
votes
0 answers

Get autosummary to produce a flat representation

If I have a file foo.baz.py: from foo.bar.baz import Quux, Quuux __all__ = ['Quux', 'Quuux'] I'd like to document the api as follows: Baz === .. currentmodule:: foo.baz .. autosummary:: :toctree: generated/ :nosignatures: Quux …
oulenz
  • 1,199
  • 1
  • 15
  • 24
1
2