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

[docs] Add auto API generator #11

Merged
merged 3 commits into from
Dec 13, 2024
Merged

[docs] Add auto API generator #11

merged 3 commits into from
Dec 13, 2024

Conversation

Routhleck
Copy link
Collaborator

@Routhleck Routhleck commented Dec 13, 2024

This pull request includes significant updates to the documentation and the addition of docstrings to the pinnx.metrics module. The most important changes include the addition of new reStructuredText (reST) templates and modules, updates to the documentation configuration, and enhancements to the pinnx.metrics functions.

Documentation Enhancements:

  • docs/_templates/classtemplate.rst: Added a new template for class documentation with hidden sections and module references.
  • docs/apis/pinnx.callbacks.rst, docs/apis/pinnx.fnspace.rst, docs/apis/pinnx.grad.rst, docs/apis/pinnx.metrics.rst, docs/apis/pinnx.rst: Added new reST files for various pinnx modules with autosummary directives for generating documentation. [1] [2] [3] [4] [5]
  • docs/auto_generater.py: Added a new Python script to automatically generate documentation for modules, including functions to write module summaries and subsections.
  • docs/conf.py: Updated the Sphinx configuration to include the newly created auto_generater script and ensure the apis/ directory is created.
  • docs/index.rst: Added a toctree directive to include API documentation for various pinnx modules.

Code Enhancements:

@chaoming0625 chaoming0625 merged commit 9e29fed into main Dec 13, 2024
12 checks passed
@chaoming0625 chaoming0625 deleted the auto-api-gen branch December 13, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants