-
-
Notifications
You must be signed in to change notification settings - Fork 678
Setup ReadTheDocs #1484
Copy link
Copy link
Closed
Milestone
Description
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:
- Land docs: initial doc generation using Sphinx #1489 (base changes to build things using Sphinx)
- 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)
- 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.
- Enable RTD building for PRs
- 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels