Docs: fix DOI badge at source & patch in built docs (to avoid rebuild) #877
Conversation
This file contains hidden or 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
sadielbartholomew
added
the
documentation
|
Confirmed to work - docs pages already updated so that the badge now shows correctly. |
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.
On the docs homepage, through the introduction page source included also (via 'include' directive) in the index, some raw HTML was included in the RST for the latest version which caused some unrendered HTML text to show up directly under the heading 'Functionality':
I've updated the RST to include it in RST format so it should render to HTML when built but to avoid a full docs re-build I have patched the affected pages (index.html and introduction.html), with the fix which should now come from source as well.
FYI @davidhassell. Will merge without review since it is simple/self-contained, but I will check that it renders OK in the updated docs once the pages update via GitHub Pages and if not push a commit to ensure it is rendering and linking as it should.