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

doc: use autoapi templates from ansys-sphinx-theme #662

Merged
merged 20 commits into from
Sep 8, 2023
Merged

Conversation

jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Aug 17, 2023

This pull-request improves the layout of the API reference section while maintaining its auto-generated nature. This is done by using the default autoapi templates that come with our theme.

This pull-request is the test scenario for ansys/ansys-sphinx-theme#278

@github-actions github-actions bot added documentation Improvements or additions to documentation maintenance Package and maintenance related labels Aug 17, 2023
@jorgepiloto jorgepiloto changed the title doc: use sphinx autosummary instead of sphinx-autoapi doc: use autoapi templates from ansys-sphinx-theme Aug 18, 2023
@RobPasMue
Copy link
Member

If failures occur due to Docker container not being able to start or connection to server is terminated, just try re-running the stage. It probably won't be caused by your changes =)

@jorgepiloto jorgepiloto marked this pull request as ready for review September 8, 2023 08:30
@jorgepiloto jorgepiloto requested a review from PipKat as a code owner September 8, 2023 08:30
@jorgepiloto jorgepiloto requested a review from a team as a code owner September 8, 2023 08:30
doc/source/conf.py Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
@RobPasMue RobPasMue enabled auto-merge (squash) September 8, 2023 08:39
@RobPasMue RobPasMue merged commit ef3447b into main Sep 8, 2023
24 checks passed
@RobPasMue RobPasMue deleted the doc/api-reference branch September 8, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants