tahoe-lafs/docs/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/
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 21:48:13 +00:00
			`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/`