Add auto-generated API docs #797
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smheidrich
commented
Sep 20, 2024
docs/library.rst
Outdated
Comment on lines
525
to
528
| Have a look at ``rope.refactor`` package and its sub-modules. For | ||
| example for performing a move refactoring you can create a ``Move`` | ||
| object like this: | ||
| Have a look at the `rope.refactor` package and its sub-modules. For | ||
| example for performing a move refactoring you can create an object | ||
| representing this operation (which will be an instance of e.g. | ||
| `MoveMethod`, `MoveModule`, ...) using `create_move`. |
There was a problem hiding this comment.
I've made a few adjustments like this one in library.rst just to show the benefit of the API docs for readers of the existing docs.
Ideally, this should be done throughout the existing docs, but I'll only do that if I get the green light for the basic idea behind this PR.
ed1ddac to
99aac98
Compare
f9645ce to
4c7bbce
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add an auto-generated API reference to Rope's docs.
Fixes #796
Details (might change as the PR evolves)
sphinx-autoapito generate the docs.