#33 rtd documentation #59
Merged
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
…t to the RTD site.
| Getting Started | ||
| ############### | ||
|
|
||
| .. mdinclude:: ../../../README.md |
There was a problem hiding this comment.
Minor rendering error here as well - note that the last two paragraphs are indented as if they're part of the bulleted list:
Co-authored-by: Glenn Matthews <[email protected]>
Updates README.md to address rendering error. Adds build directory to .gitignore
dgarros
approved these changes
Oct 8, 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.
Solves for #33 to produce RTD documentation on the diffsync library using the README files as a documentation source for details and examples, and using sphinx-apidoc for API reference doc generation.
I haven't created the RTD diffsync site on the github project just yet, but I can do that after we get everything lined out here. There is example documentation here https://diffsync-test.readthedocs.io/en/33-rtd-documentation/index.html