1 | If you are reading Tahoe-LAFS documentation |
---|
2 | ------------------------------------------- |
---|
3 | |
---|
4 | If you are reading Tahoe-LAFS documentation at a code hosting site or |
---|
5 | from a checked-out source tree, the preferred place to view the docs |
---|
6 | is http://tahoe-lafs.readthedocs.io/en/latest/. Code-hosting sites do |
---|
7 | not render cross-document links or images correctly. |
---|
8 | |
---|
9 | |
---|
10 | If you are writing Tahoe-LAFS documentation |
---|
11 | ------------------------------------------- |
---|
12 | |
---|
13 | To edit Tahoe-LAFS docs, you will need a checked-out source tree. You |
---|
14 | can edit the `.rst` files in this directory using a text editor, and |
---|
15 | then generate HTML output using Sphinx, a program that can produce its |
---|
16 | output in HTML and other formats. |
---|
17 | |
---|
18 | Files with `.rst` extension use reStructuredText markup format, which |
---|
19 | is the format Sphinx natively handles. To learn more about Sphinx, and |
---|
20 | for a friendly primer on reStructuredText, please see Sphinx project's |
---|
21 | documentation, available at: |
---|
22 | |
---|
23 | https://www.sphinx-doc.org/ |
---|
24 | |
---|
25 | If you have `tox` installed, you can run `tox -e docs` and then open |
---|
26 | the resulting docs/_build/html/index.html in your web browser. |
---|
27 | |
---|
28 | Note that Sphinx can also process Python docstrings to generate API |
---|
29 | documentation. Tahoe-LAFS currently does not use Sphinx for this |
---|
30 | purpose. |
---|