Skip to content

Documentation on readthedocs #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
glennmatthews opened this issue Oct 26, 2020 · 5 comments · Fixed by #68
Closed

Documentation on readthedocs #33

glennmatthews opened this issue Oct 26, 2020 · 5 comments · Fixed by #68
Assignees
@josh-silvas
Labels
status: accepted This issue has been accepted by the maintainers team for implementation type: documentation

Comments

@glennmatthews
Copy link
Collaborator

Environment

  • DiffSync version: 1.0.0

Proposed Functionality

Documentation generation and publication to readthedocs.org, including examples

Use Case

Discoverability, usability.
@itdependsnetworks
Copy link
Contributor

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

@glennmatthews
Copy link
Collaborator Author

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

@glennmatthews
Copy link
Collaborator Author

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 dgarros added help wanted status: accepted This issue has been accepted by the maintainers team for implementation type: documentation and removed enhancement labels Jun 18, 2021
@dgarros
Copy link
Contributor

dgarros commented Jun 18, 2021

@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
Copy link
Contributor

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

@josh-silvas josh-silvas mentioned this issue Jun 22, 2021
Merged
dgarros added a commit that referenced this issue Oct 8, 2021
@dgarros
Merge pull request #59 from josh5276/#33-rtd-documentation
3c3060f 
#33 rtd documentation
@dgarros dgarros mentioned this issue Oct 8, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@josh-silvas josh-silvas

Labels
status: accepted This issue has been accepted by the maintainers team for implementation type: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Cleanup Readme, add link to new documentation site networktocode/diffsync
4 participants
@dgarros @glennmatthews @josh-silvas @itdependsnetworks