Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Automatically generated toctree for methods and classes

See original GitHub issue

🚀 Feature

Idea is to replace our manually created toctree for metrics, handlers, regression metrics etc.

How to do that :

check .. autosummary:: tag in Sphinx
add it and configure for each listed above .rst file : metrics.rst, handlers.rst etc

Example of usage:

This issue maybe or maybe not blocked by #1272

For Hacktoberfest contributors, feel free to ask questions for details if any and say that you would like to tackle the issue. Please, take a look at CONTRIBUTING guide.

Issue Analytics

State:
Created 3 years ago
Comments:15 (7 by maintainers)

Top GitHub Comments

1reaction

theodumontcommented, Oct 4, 2020

Done!

0reactions

theodumontcommented, Oct 19, 2020

Sorry for the late response. If @trsvchn can continue working on it it is ok for me!

Top Results From Across the Web

Automatically create a toctree for autodoc classes in Sphinx

Is there a way to automatically create this toctree for each of the classes being documented with autodoc? python · python-sphinx · autodoc...

Create a ToC entry for every function, method, class, etc #6316

It would be useful to have an option that causes Sphinx to automatically create a TOC entry for every function, class, and method....

sphinx.ext.autosummary – Generate autodoc summaries

This extension generates function/method/attribute summary lists, similar to those output e.g. by Epydoc and other API doc generation tools.

Populating our documentation - Sphinx-RTD-Tutorial

The sphinx-apidoc command can be used to auto-generate some .rst files for ... In case of classes and methods defined within our modules, ......

Configuration — Sphinx-Gallery 0.11.1-git documentation

Refer to that function/method/attribute/object/class using sphinx markup :func: ... explain how the Sphinx-Gallery API Reference is automatically generated.