Skip to content

Documentation on readthedocs #33

Closed

Description

@glennmatthews

Environment

  • DiffSync version: 1.0.0

Proposed Functionality

Documentation generation and publication to readthedocs.org, including examples

Use Case

Discoverability, usability.

Activity

  1. itdependsnetworks commented on Oct 27, 2020

    @itdependsnetworks
    Contributor

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

  2. glennmatthews commented on Oct 27, 2020

    @glennmatthews
    CollaboratorAuthor

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

  3. glennmatthews commented on Nov 2, 2020

    @glennmatthews
    CollaboratorAuthor

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

  4. dgarros commented on Jun 18, 2021

    @dgarros
    Contributor

    @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

  5. josh-silvas commented on Jun 18, 2021

    @josh-silvas
    Contributor

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

  6. added a commit that references this issue on Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

status: acceptedThis issue has been accepted by the maintainers team for implementationtype: documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions