Skip to content

Create Sphinx documentation and host on Read The Docs #8

@felix-hilden

Description

@felix-hilden

From #7: Let's build and host the documentation on RTD then! I'd be happy to help in this way, since for me it seems like low-hanging fruit 👍

So what would you like in the documentation, since beartype has no API?

I would propose the following, which I did for my library (RTD site for reference):

  • RTD becomes the home site for beartype, because there is no ugly file contents blocking the readme, like on GitHub
  • We move the changelog and the (extremely) terse reference documentation there into one section, and create another section for tutorials, examples, explanations and such. GitHub readme becomes essentially an introduction to the repository, not the package. Although at this stage there's an argument to be made for keeping things in the GitHub readme still.

Thoughts?

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