Documentation on readthedocs

[glennmatthews]

Environment

• DiffSync version: 1.0.0

Proposed Functionality

Documentation generation and publication to readthedocs.org, including examples

Use Case

Discoverability, usability.

[itdependsnetworks]

Would be great to include a few examples in the docs as well.

[glennmatthews]

Agreed. We have the one example (examples/example1/) but more would definitely be desirable.

[glennmatthews]

It looks like Poetry + ReadTheDocs is not a trivially solved problem - see readthedocs/readthedocs.org#4912, although there are some possible workarounds listed there.

[dgarros]

@josh5276 please can you look into this issue
We should be able to replicate the work that has been done in https://github.com/networktocode/netutils
The goal of this issue is to integrate this repo with RTD and move what we have in the README into a basic doc site for now
I'll open more issue to improve the documentation

[josh-silvas]

Sure thing @dgarros, I'll look into it.