#2753 closed task (fixed)

publish docs to readthedocs.org

Reported by: warner Owned by: daira
Priority: normal Milestone: 1.11.0
Component: documentation Version: 1.10.2
Keywords: docs Cc:
Launchpad Bug:


Currently, the best way to read the Tahoe docs is either from a source tree (git, or unpacked tarball), or online on github. Only the latter provides any formatting of the .rst files.

Most other Python projects (and quite a few non-python ones) are publishing their docs to readthedocs.org . They do an rst-to-HTML build step that adds nice things like a table of contents, and a clear way to find docs for specific versions.

I'd like to figure out how to publish our docs that way too. Then I think we can start on some organizational improvements, to make the docs more like an instruction manual and less like a haphazard collection of design notes. The .rst source will still live in docs/, but we'll use the README and the Trac wiki front page to point people at readthedocs.org instead.

I don't know what mechanics are involved. I believe it will need some new .rst files (for the TOC and front-matter), and maybe something in the buildbot to trigger pushes to readthedocs.org on each commit/release.

Change History (2)

comment:1 Changed at 2016-06-28T18:20:37Z by warner

  • Milestone changed from 1.12.0 to 1.13.0

moving most tickets from 1.12 to 1.13 so we can release 1.12 with magic-folders

comment:2 Changed at 2016-09-28T08:08:52Z by warner

  • Milestone changed from 1.13.0 to 1.11.0
  • Resolution set to fixed
  • Status changed from new to closed

we actually got this done in 1.11.0, but I forgot to close the ticket. http://tahoe-lafs.readthedocs.io/en/latest/

Note: See TracTickets for help on using tickets.