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

feat: add API templates #278

Merged
merged 60 commits into from
Sep 8, 2023
Merged

feat: add API templates #278

merged 60 commits into from
Sep 8, 2023

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Aug 18, 2023

This pull-request introduces a collection of templates to be reused by our libraries.

  • Link every object into a single page. Not possible for the moment, see Allow the choice of classes having their own page readthedocs/sphinx-autoapi#226

  • Dynamically generated summary table made of tabs that dynamically splits between "packages", "modules", "interfaces", "classes", "enums", "constants", and "attributes"

  • Compact and optimize previous code using macros

  • Agree on a common set of globals to be used in the "index.rst" page of the template: project name, description...

@github-actions github-actions bot added documentation enhancement General improvements to existing features labels Aug 18, 2023
@jorgepiloto jorgepiloto force-pushed the feat/api-templates branch 4 times, most recently from 6065b0d to 47bd75e Compare August 18, 2023 16:04
@jorgepiloto jorgepiloto marked this pull request as ready for review September 8, 2023 06:32
@jorgepiloto jorgepiloto requested a review from a team as a code owner September 8, 2023 06:32
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM! Best way to test it is to see it life

@RobPasMue
Copy link
Member

Can we get this merged and do a release asap? 0.11.0

@jorgepiloto
Copy link
Member Author

Let's go with these changes. We will perform all the corresponding patch releases if we face any issues.

@jorgepiloto jorgepiloto merged commit f513218 into main Sep 8, 2023
21 checks passed
@jorgepiloto jorgepiloto deleted the feat/api-templates branch September 8, 2023 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement General improvements to existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants