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

API writes module names in full #26

Closed
redeboer opened this issue Aug 16, 2024 · 2 comments · Fixed by #25
Closed

API writes module names in full #26

redeboer opened this issue Aug 16, 2024 · 2 comments · Fixed by #25
Assignees
Labels
🐛 Bug Something isn't working 📝 Docs Improvements or additions to documentation
Milestone

Comments

@redeboer
Copy link
Member

Previously, APIs or ComPWA packages abbreviate module names to the name itself, not the full module path. See for instance https://ampform.rtfd.io/0.15.4:
image

Since some update to the dependencies (probably Sphinx v8?), the sidebar looks like this:
image

See (for now) https://ampform.rtfd.io/latest

@redeboer redeboer added 🐛 Bug Something isn't working 📝 Docs Improvements or additions to documentation labels Aug 16, 2024
@redeboer redeboer self-assigned this Aug 16, 2024
@redeboer
Copy link
Member Author

redeboer commented Oct 4, 2024

In AmpForm, the problem was introduced in ComPWA/ampform@1a7d34f, which upgraded to Sphinx v8.

@redeboer
Copy link
Member Author

redeboer commented Oct 4, 2024

The cause seems to be that .rst_t files are not recognized in Sphinx v7.4 and v8.0 (sphinx-doc/sphinx#12916) and sphinx-api-relink inserts files like module.rst_t. This should be fixed in Sphinx v8.1, see Sphinx changelog.

See also #24

@redeboer redeboer transferred this issue from ComPWA/policy Oct 4, 2024
@redeboer redeboer added this to the 0.0.10 milestone Oct 4, 2024
@redeboer redeboer assigned shenvitor and unassigned shenvitor Oct 4, 2024
@redeboer redeboer modified the milestones: 0.0.10, 0.0.11 Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 Bug Something isn't working 📝 Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants