python-rope / rope

a python refactoring library

GNU Lesser General Public License v3.0

1.96k stars 164 forks source link

Add auto-generated API docs #797

Open smheidrich opened 1 month ago

smheidrich commented 1 month ago

Description

Add an auto-generated API reference to Rope's docs.

Fixes #796

Details (might change as the PR evolves)

Currently uses sphinx-autoapi to generate the docs.
Lots of warnings during the docs build due to references that can't be found (mostly due to Markdown-like single-backtick inline code in docstrings), but result looks all right.
Would obviously benefit greatly from enabling pull request reviews in the ReadTheDocs setting.