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

Switching to & configuring autoapi.extension for build docs #242

Merged
merged 3 commits into from
Sep 13, 2023

Conversation

ns-rse
Copy link
Collaborator

@ns-rse ns-rse commented Sep 13, 2023

In order to get the API documentation to build on ReadTheDocs.org this PR switches to using the autoapi.extension.

Tested and builds on this branch see for example here.

@ns-rse ns-rse added documentation Improvements or additions to documentation CI/CD Continuous Integration and Development labels Sep 13, 2023
@codecov
Copy link

codecov bot commented Sep 13, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (96abbe3) 69.37% compared to head (6254156) 69.37%.
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #242   +/-   ##
=======================================
  Coverage   69.37%   69.37%           
=======================================
  Files          11       11           
  Lines         493      493           
=======================================
  Hits          342      342           
  Misses        151      151           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TheLostLambda
Copy link
Member

Looks promising! I'll give it a go!

@TheLostLambda TheLostLambda merged commit 21670ab into master Sep 13, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Continuous Integration and Development documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants