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.

Sign up for GitHub

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

Jump to bottom

Fix paper references not being highlighted #351

Open
paddyroddy opened this issue Oct 10, 2024 · 0 comments
Open

Fix paper references not being highlighted #351

paddyroddy opened this issue Oct 10, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@paddyroddy
Copy link
Member

Which Section of the Documentation Needs Improving?

This happening due to this bug, sphinx-doc/sphinx#9689. Hopefully, this is fixed in future. Broken in #347.

What Can be Improved About This Section

Fix references

How to Improve This Section

No response
@paddyroddy paddyroddy added bug Something isn't working documentation Improvements or additions to documentation labels Oct 10, 2024
This was referenced Oct 10, 2024
Merged
Closed
paddyroddy added a commit that referenced this issue Oct 14, 2024
@paddyroddy
gh-346: enforce NumPy docstrings + use static typing in docs (#347)
41c4266 
Closes #346. Working towards #188.

The main changes here have been:
- Remove all types in the docstrings in favour of proper static typing
(being added in #308)
- Switch from `numpydoc` to `sphinx.ext.napolean` due to
numpy/numpydoc#196

Have had to change the references to `[1]` rather than `[1]_` due to
this bug, sphinx-doc/sphinx#9689. Hopefully
this can be fixed in the future.

Example:
`glass.lensing.from_convergence`
<img width="781" alt="image"
src="https://github.com/user-attachments/assets/9b6fd087-686a-4a5c-a77a-f8a3ec9fc3e2">

Raised #350, #351.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@paddyroddy