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

sphinx-autoapi #328

Merged
merged 4 commits into from Apr 15, 2022
Merged

sphinx-autoapi #328

merged 4 commits into from Apr 15, 2022

Conversation

tony
Copy link
Member

@tony tony commented Apr 15, 2022

Workaround for "Option to create a TOC entry for each function, class, and method" in sphinx: sphinx-doc/sphinx#6316

This will use autoapi_generate_api_docs = False and the sphinx-autoapi directive's by hand.

@codecov
Copy link

codecov bot commented Apr 15, 2022

Codecov Report

Merging #328 (f29f96f) into master (1b8b48a) will increase coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #328      +/-   ##
==========================================
+ Coverage   72.34%   72.40%   +0.06%     
==========================================
  Files          21       21              
  Lines        1685     1689       +4     
==========================================
+ Hits         1219     1223       +4     
  Misses        466      466              
Impacted Files Coverage Δ
docs/conf.py 60.86% <100.00%> (+1.77%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b8b48a...f29f96f. Read the comment docs.

@tony tony merged commit f299bc3 into master Apr 15, 2022
@tony tony deleted the autoapi branch April 15, 2022 13:00
@tony tony added this to the v0.12 milestone May 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

1 participant