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

Fixing issues with Citations & Label references in Docs #1577

Merged
merged 4 commits into from
May 25, 2021

Conversation

DhruvSondhi
Copy link
Contributor

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?

  • Testing pipeline.
  • Other. Local Testing

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@DhruvSondhi DhruvSondhi force-pushed the documentation_formatting branch 2 times, most recently from 27ba647 to cc942e1 Compare May 20, 2021 15:58
@codecov
Copy link

codecov bot commented May 20, 2021

Codecov Report

Merging #1577 (b8f619d) into master (7eca324) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

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

Copy link
Member

@isaacgsmith isaacgsmith left a 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 

@DhruvSondhi DhruvSondhi requested a review from isaacgsmith May 21, 2021 16:48
Copy link
Member

@isaacgsmith isaacgsmith left a 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!

@DhruvSondhi DhruvSondhi force-pushed the documentation_formatting branch from 3e8d58b to c956467 Compare May 22, 2021 04:50
@DhruvSondhi DhruvSondhi force-pushed the documentation_formatting branch from c956467 to 551bb1f Compare May 24, 2021 14:50
@marxwillia
Copy link
Contributor

@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.

@isaacgsmith
Copy link
Member

@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.

@DhruvSondhi
Copy link
Contributor Author

DhruvSondhi commented May 25, 2021

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 gh-pages branch (all thanks to @epassaro 🙌🏼 ) which can be seen here but I cannot generate the docs from this branch apparently. I am trying to figure out where the problem could be lurking but it seems distant from a potential fix. If I can share the screenshots of the documentation thus built locally, would it be adequate?

@marxwillia marxwillia merged commit 02008d7 into tardis-sn:master May 25, 2021
@DhruvSondhi DhruvSondhi deleted the documentation_formatting branch May 27, 2021 13:25
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
…atting

Fixing issues with `Citations` & `Label` references in Docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants