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 the documentation bug #1527

Merged
merged 1 commit into from
Apr 7, 2021

Conversation

atharva-2001
Copy link
Member

The PR is an attempt to fix the documentation bug, mentioned in #1522 and #1523

Description

The sphinx-rtd-theme is incompatible with docutil v0.17, and downgrading it solves the problem. This issue is tracked here.

Motivation and Context

resolves #1523
resolves #1522

How Has This Been Tested?

  • Testing pipeline
  • Reference Data Comparison following these instructions
  • Other (please describe)

I have tested this in my documentation.

Screenshots (if appropriate):

Before:


After:

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • None of the above (please describe)

Checklist:

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have built the documentation on my fork following these instructions
  • I have assigned and requested two reviewers for this pull request

@codecov
Copy link

codecov bot commented Apr 7, 2021

Codecov Report

Merging #1527 (310635b) into master (8d7e44b) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 310635b differs from pull request most recent head bf2af14. Consider uploading reports for the commit bf2af14 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1527   +/-   ##
=======================================
  Coverage   67.57%   67.57%           
=======================================
  Files          68       68           
  Lines        6103     6100    -3     
=======================================
- Hits         4124     4122    -2     
+ Misses       1979     1978    -1     
Impacted Files Coverage Δ
tardis/tardis/plasma/properties/ion_population.py 86.13% <0.00%> (-0.14%) ⬇️
...rdis/tardis/montecarlo/montecarlo_numba/vpacket.py 17.64% <0.00%> (+0.17%) ⬆️

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 8d7e44b...bf2af14. Read the comment docs.

Copy link
Member

@jaladh-singhal jaladh-singhal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for figuring it out @atharva-2001 - excellent job!

Copy link
Member

@epassaro epassaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Please watch that issue to get news about it. We do not want to pin so many dependencies.

@epassaro epassaro merged commit 09f992f into tardis-sn:master Apr 7, 2021
@atharva-2001
Copy link
Member Author

Sure. I will keep a watch on it.

atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request Apr 10, 2021
@atharva-2001 atharva-2001 deleted the sphinx_rtd_theme_bug_fix branch April 23, 2021 07:26
atharva-2001 added a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
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.

Visualization section's notebooks not getting included in the docs Sidebar of docs has buggy layout
4 participants