Skip to content

Setup ReadTheDocs #1484

@aignas

Description

@aignas

See this comment by @rickeylev

The main idea would be to setup a ReadTheDocs instance for better documentation and this could be a way to solve #1332. There is a reserved URL for this project and the setup could be split into multiple PRs as follows

TODO list:

  1. Land docs: initial doc generation using Sphinx #1489 (base changes to build things using Sphinx)
  2. Reconfigure RTD to read from a new branch, "rtd-testing". This is test the RTD build process (it only builds from commits, but you can tell it to use specific branches)
  3. Land another PR on main with the changes from (2). At this point, RTD will be building and publishing the main branch and our tagged versions.
  4. Enable RTD building for PRs
  5. Port plain stardoc md/html docs over to Sphinx/RTD. This will require various changes to docstrings etc so that things group and render nicely.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions