Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FEAT: generate API with simple configuration value #1

Merged
merged 2 commits into from
Dec 4, 2023
Merged

FEAT: generate API with simple configuration value #1

merged 2 commits into from
Dec 4, 2023

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Dec 4, 2023

This PR makes it possible to generate an API through sphinx.ext.autodoc by adding this to your conf.py:

api_package_path = "../src/my_package"  # relative to conf.py

More configuration values can be found in README.md.

The extension wraps legacy codes like this.

@redeboer redeboer self-assigned this Dec 4, 2023
@redeboer redeboer added the ✨ Feature New feature added to the package label Dec 4, 2023
@redeboer redeboer merged commit ecc0db1 into main Dec 4, 2023
9 checks passed
@redeboer redeboer deleted the generate-api branch December 4, 2023 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@redeboer redeboer

Labels
✨ Feature New feature added to the package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@redeboer