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

Fix intersphinx inventory #237

Merged
merged 1 commit into from
Jun 3, 2022
Merged

Fix intersphinx inventory #237

merged 1 commit into from
Jun 3, 2022

Conversation

jayqi
Copy link
Member

@jayqi jayqi commented Jun 3, 2022

Fixes missing entries from Intersphinx inventory file by including root object in TOC for mkdocstrings. Closes #211.

The inventory file is available at <base-url>/objects.inv and can be parsed by sphobjinv.

Some additional changes:

@github-actions
Copy link
Contributor

github-actions bot commented Jun 3, 2022

@codecov-commenter
Copy link

codecov-commenter commented Jun 3, 2022

Codecov Report

Merging #237 (73c7d07) into master (7e0356c) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #237   +/-   ##
======================================
  Coverage    94.8%   94.8%           
======================================
  Files          21      21           
  Lines        1323    1323           
======================================
  Hits         1255    1255           
  Misses         68      68           

@pjbull
Copy link
Member

pjbull commented Jun 3, 2022

Looks good to me! I diffed the old and the new and see the class level ones mentioned in the issue showing up:
image

@pjbull
Copy link
Member

pjbull commented Jun 3, 2022

@jayqi shall we cut a release with this one?

@jayqi jayqi merged commit 39e2e77 into master Jun 3, 2022
@jayqi jayqi deleted the 211-fix-intersphinx-inventory branch June 3, 2022 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix API Reference header formatting for Intersphinx
3 participants