-
Notifications
You must be signed in to change notification settings - Fork 103
[DOCS] create custom api doc templates #847
Copy link
Copy link
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Great First Contribution! 🌱Beginner friendly tickets with narrow scope and huge impact. Perfect to join our community!Beginner friendly tickets with narrow scope and huge impact. Perfect to join our community!Impact > Moderate 🔶User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).
Milestone
Metadata
Metadata
Assignees
Labels
Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Mid-sized tasks estimated to take a few days to a few weeks.Great First Contribution! 🌱Beginner friendly tickets with narrow scope and huge impact. Perfect to join our community!Beginner friendly tickets with narrow scope and huge impact. Perfect to join our community!Impact > Moderate 🔶User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).
Type
Fields
Give feedbackNo fields configured for Bug.
Projects
Status
In progress
the api pages appear to be generated using sphinx default templates, which contains a method summary. the summary is meant to link to individual pages for each method. however, this is overkill for our repo. a custom template will allow us to forgo the method summary, and simply list all methods on the same page.
this should be done before we get to api docstrings at the method level, as those aren't currently shown in the method summary tables.