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.

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

Automatically generate API References #731

Merged
merged 8 commits into from
Aug 23, 2023
Merged

Conversation

linshokaku
Copy link
Member

Apply autosummary recursively to automatically generate all API documentation.

cf. #723

@@ -1,147 +1,143 @@
.. module:: pytorch_pfn_extras
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the module directive, as it impacts the links to the pytorch_pfn_extras package

@@ -0,0 +1,68 @@
{{ fullname | escape | underline}}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@linshokaku linshokaku marked this pull request as draft July 24, 2023 12:34
@linshokaku linshokaku changed the title Automatically generate API References [WIP] Automatically generate API References Jul 24, 2023
@linshokaku linshokaku marked this pull request as ready for review July 25, 2023 02:45
@linshokaku linshokaku changed the title [WIP] Automatically generate API References Automatically generate API References Jul 25, 2023
@takagi takagi added the cat:docs Improvements or additions to documentation label Jul 25, 2023
Copy link
Member

@kmaehashi kmaehashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the delay 🙇

docs/requirements.txt Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/reference/index.rst Outdated Show resolved Hide resolved
@kmaehashi kmaehashi merged commit 4582450 into master Aug 23, 2023
10 checks passed
@kmaehashi kmaehashi deleted the auto-generated-api-reference branch August 23, 2023 11:25
@kmaehashi
Copy link
Member

Thanks, LGTM!

@kmaehashi kmaehashi added this to the v0.7.2 milestone Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat:docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants