Convert doc directory to reStructuredText #579
Merged
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
jwrober
changed the title
|
Quick link to the URL for the documents in this PR - https://longturn--579.org.readthedocs.build/en/579/ |
Mostly grammar changes, fixed a few todo's and cleaned up the content a bit.
Default for RTD theme was to show nothing at all for simple class unordered lists.
lmoureaux
reviewed
Aug 4, 2021
|
I think this bad boy is about ready for a merge. |
lmoureaux
approved these changes
Aug 4, 2021
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 is a start at converting
doc/FAQto reStructuredText. As part of this exercise I determined that we also need to look at producing plain text version of the.rstfiles at release time. This draft PR shows many TODO's in it for just the FAQ I think it might be prudent to collect a number of commits on this branch to get a few things done in one big commit. Comments welcome.One thing I know I want to add to this PR is a style guide and then to "fix" the existing
.rstfiles to match. I'm already starting to notice differences.