ben-spiller / sphinx-autodocgen Goto Github PK
View Code? Open in Web Editor NEWExtension for the Sphinx documentation generator that automatically generates .rst files for your Python modules
License: MIT License
Extension for the Sphinx documentation generator that automatically generates .rst files for your Python modules
License: MIT License
Hello,
First thanks for the work, it's really useful.
I'm trying to use the extension to generate documentation for a python module, and the basis works great. However, I can't figure out how to make it recursive...
E.g.
If I have a submodule core.core_data
In there, I have a class DataSeries
that's imported in the submodule with
from from .data_series import DataSeries
The documentation generated includes the docstring for the data_series file, but only a mention of the DataSeries class and nothing about its content.
And if I rename the file data_series.py
into DataSeries.py
(and accordingly import the latter), the generated documentation includes the whole class docstring, and a list of methods, but not the detailed description of each method.
The same type of things seems to happen whenever a function doesn't have the name of the file, too, the documentation for the function isn't generated.
Is this intended? How should I go about making it include the missing classes?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.