Skip to content

Documentation using mkdocs #74

@ShantanuKodgirwar

Description

@ShantanuKodgirwar

@wfeschen @dboonz

Something that must be done sooner or later is to create a separate documentation (accessible via URL) for PtyLab. A modern library that is used quite often for this is mkdocs, I propose we create this and add the installation instructions, contributions and most importantly the examples and tutorials there. I am not sure if I have the time to do this right now, but just wanted to note it here for future reference.

I personally think, this is the biggest hindrance when it comes to using any package—a good documentation!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions