search

pylint-dev / astroid

A common base representation of python source code for pylint and other projects
https://pylint.readthedocs.io/projects/astroid/en/latest/
GNU Lesser General Public License v2.1
533 stars 276 forks source link

Publish full API documentation #1337

Open tristanlatr opened 2 years ago

tristanlatr commented 2 years ago

Hello,

It would good to publish the full astroid reference in the documentation, not only the classes, but the AstroidBuilder and other important building blocks.

In the mean time, I've generated the full API reference here: https://tristanlatr.github.io/apidocs/astroid/astroid.html

DanielNoord commented 2 years ago

A lot of the functions and modules there are "Undocumented". What does such a reference offer compared to just docstrings in the code?

tristanlatr commented 2 years ago

I find it much more efficient to skim throught the documentation than the code. All inherited methods/attributes are listed on the classes page, which is very helpful when starting using astroid.

Some classes/modules are pretty well documented, I think it would be great to honour the docstring writers by generating HTML from their documentation.

Helpful pages for an astroid beginner:

astroid.nodes package documentation: https://tristanlatr.github.io/apidocs/astroid/astroid.nodes.html AstroidBuilder class documentation: https://tristanlatr.github.io/apidocs/astroid/astroid.builder.AstroidBuilder.html AstroidManager class documentation: https://tristanlatr.github.io/apidocs/astroid/astroid.manager.AstroidManager.html astroid.helpers module documentation: https://tristanlatr.github.io/apidocs/astroid/astroid.helpers.html

Pierre-Sassoulas commented 2 years ago

I'm clearing the milestone so we can release astroid 2.10, this is not strictly necessary.