Uh oh!
There was an error while loading. Please reload this page.
#33 rtd documentation - #59
Conversation
glennmatthews
left a comment
There was a problem hiding this comment.
This is a great start, thank you!
Uh oh!
There was an error while loading. Please reload this page.
| Getting Started | ||
| ############### | ||
| .. mdinclude:: ../../../README.md |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Updates README.md to address rendering error. Adds build directory to .gitignore
dgarros
left a comment
There was a problem hiding this comment.
I'm gonna merge this one, publish it and we'll fix rendering issue has we find them

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