-
-
Notifications
You must be signed in to change notification settings - Fork 409
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
Fixing issues with Citations
& Label
references in Docs
#1577
Fixing issues with Citations
& Label
references in Docs
#1577
Conversation
27ba647
to
cc942e1
Compare
Codecov Report
@@ Coverage Diff @@
## master #1577 +/- ##
=======================================
Coverage 67.20% 67.20%
=======================================
Files 73 73
Lines 6147 6147
=======================================
Hits 4131 4131
Misses 2016 2016 Continue to review full report at Codecov.
|
b6812c4
to
7f47022
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything looks good -- there were three more broken citations if you're able to fix them:
docs/physics/montecarlo/propagation.rst:39: WARNING: citation not found: Bjorkmann1999
docs/physics/plasma/nebular_plasma.rst:39: WARNING: citation not found: 1993A&A...279..447M
docs/physics/plasma/nebular_plasma.rst:63: WARNING: citation not found: 1993A&A...279..447M
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect! I built it locally and everything is working!
3e8d58b
to
c956467
Compare
c956467
to
551bb1f
Compare
@DhruvSondhi in order to speed up the review process, can you please include a link to your local build of the documentation for PR's like this one where you implement changes? See PR 1584 for an example. |
@marxwillia I don't know if Dhruv got this fixed yet, but there was an issue with his documentation deploying. That's why I had just built it locally. |
Hello @marxwillia, Sorry for the late response 😓 . There is some problem with my GitHub Pages Documentation Deployment (as already mentioned by @smithis7 😄 ). I can generate the documentation from the |
…atting Fixing issues with `Citations` & `Label` references in Docs
Fixes issues with citations & labels for documentation generation
Description
Citations & Label referencing in the current documentation do not work as intended.
This PR aims to fix this :)
Motivation and context
Citations are now referenced correctly
Labels now point to the correct part of the documentation
How has this been tested?
Type of change
Checklist