Fixing inconsistencies for rst formatting in Docs (Second Iteration)
#1590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DhruvSondhi
force-pushed
the
docs_formatting_v2
branch
from
a4ffd03 to
bed98dc
Compare
Codecov Report
@@ Coverage Diff @@
## master #1590 +/- ##
=======================================
Coverage 67.20% 67.20%
=======================================
Files 73 73
Lines 6147 6147
=======================================
Hits 4131 4131
Misses 2016 2016 Continue to review full report at Codecov.
|
isaacgsmith
reviewed
May 27, 2021
DhruvSondhi
force-pushed
the
docs_formatting_v2
branch
from
59cd92a to
458ee36
Compare
DhruvSondhi
commented
May 27, 2021
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
tardis-sn#1590) * Fixing inconsistencies for rst formatting * Setting code-block lexer to none in update_refdata
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to fix some of the inconsistencies are present in the current documentation.
Fixing this also removes some of the warnings that are present when building the documentation 😄
Description
Some of the changes include small whitespace, tabs & newline additions
Others includes removing the
Nonekeyword from.. code-block::directives inupdate_refdata.rst, updating the underlines for some of the headings.Motivation and context
This will fix some of the warnings that are present when building the documentation locally 😄
Documentation Preview : https://dhruvsondhi.github.io/tardis/branch/docs_formatting_v2/
How has this been tested?
Type of change
Checklist