ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-20 21:43:09 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
b7099f147d
tahoe-lafs/docs
History
Brian Warner 91047bf828 docs: clean up .rst and references 
This uses Read-The-Docs (sphinx/docutils) references exclusively, but adds a
README.md for GitHub viewers to remind them that the links there won't
work (closes ticket:2835).

It also fixes all the dangling references and other Sphinx warnings.

The "Preparation" section of docs/magic-folder-howto.rst was removed, since
this feature has since been merged to trunk.
2016-12-12 13:57:28 -08:00
..
_static docs: add .empty to preserve empty _static and _templates 2016-03-30 01:26:47 -07:00
_templates docs: add .empty to preserve empty _static and _templates 2016-03-30 01:26:47 -07:00
build Update title of OpenSSL and pyOpenSSL build instructions. 2015-05-01 22:07:27 +01:00
frontends docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
historical magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
man/man1 CLI: remove 'debug trial', 'debug repl' 2016-09-09 15:37:28 -07:00
proposed docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
specifications docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
about.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
anonymity-configuration.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
architecture.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
backdoors.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
backupdb.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
cautions.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
conf.py docs: switch to default readthedocs.org theme 2016-03-30 02:18:00 -07:00
configuration.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
convergence-secret.rst docs: add sphinx index.rst, improve headers 2016-03-29 21:46:11 -07:00
debian.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
desert-island.rst desert-island: new approach, works better 2016-03-31 17:12:08 -07:00
donations.rst donation.rst: add new expense addresses, re-sign 2016-11-10 21:16:34 -08:00
expenses.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
filesystem-notes.rst update link to Maildir tips (thanks MK_FG) 2013-11-12 16:37:02 +00:00
garbage-collection.rst Fix typos in garbage-collection.rst 2016-09-24 23:05:09 +01:00
helper.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
how_to_make_a_tahoe-lafs_release.org relnotes, docs: post-release fixups 2016-03-30 17:27:44 -07:00
index.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
INSTALL.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
key-value-store.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
known_issues.rst update relnotes and known_issues 2016-03-30 02:25:27 -07:00
lease-tradeoffs.svg Fixes the overlapping text in docs/lease-tradeoffs.svg 2013-08-07 13:12:59 -04:00
logging.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
magic-folder-howto.rst docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
Makefile docs: run sphinx-quickstart, move old Makefile 2016-03-29 21:02:14 -07:00
Makefile-old docs: run sphinx-quickstart, move old Makefile 2016-03-29 21:02:14 -07:00
network-and-reliance-topology.svg Update docs/network-and-reliance-topology.svg for RAIC, and to be more accurate about frontend protocols. 2012-11-03 00:15:32 +00:00
nodekeys.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
OS-X.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
performance.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00
README.md docs: clean up .rst and references 2016-12-12 13:57:28 -08:00
running.rst docs: more server/introducer setup text 2016-09-14 13:10:29 -07:00
servers.rst implement --listen=none, use it for create-client 2016-09-14 16:12:32 -07:00
stats.rst stats-gatherer: add --hostname/--location/--port 2016-05-04 17:58:45 -07:00
subtree1.svg docs/subtree1.svg: make the page smaller 2007-11-13 13:54:51 -07:00
windows.rst format docs for Sphinx 2016-03-30 01:26:47 -07:00
write_coordination.rst magic first line tells emacs to use utf8+bom 2013-11-08 21:08:05 +00:00

README.md

Note: http://tahoe-lafs.readthedocs.io/en/latest/ is the preferred place to read this documentation (GitHub doesn't render cross-document links or images). If you're reading this on https://github.com/tahoe-lafs/tahoe-lafs , or from a checked-out source tree, then either run tox -e docs and open _build/html/index.html in your browser, or view the pre-rendered trunk copy at http://tahoe-lafs.readthedocs.io/en/latest/