Brian Warner
f81900ee35
format docs for Sphinx
...
Added indexes, fixed cross-references.
Also a few pip-related cleanups I noticed along the way.
2016-03-30 01:26:47 -07:00
Brian Warner
142185bb86
docs: add sphinx index.rst, improve headers
2016-03-29 21:46:11 -07:00
Brian Warner
090b592ff8
docs: rename quickstart to INSTALL
2016-03-25 18:26:54 -07:00
Daira Hopwood
7309aed524
Change some instances of "filesystem" that were missed to "file store".
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-07-31 18:21:47 +01:00
Daira Hopwood
6a38a3c54e
Rename README.txt to README.rst, and add Travis-CI and Coveralls badges to it.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-09 18:51:44 +01:00
Daira Hopwood
1e3a2994e2
Reference README.txt from License section of docs/about.rst, rather than duplicating the license info. fixes #2067
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-02 19:37:06 +01:00
Daira Hopwood
419df9b0b4
docs/about.rst: Reword and remove redundancy. Also avoid "(S)FTP".
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-12-04 01:23:11 +00:00
pataquets
857d072ff4
Warn about ambiguities on "client" and "gateway" terms
2013-12-03 17:25:45 +01:00
Zooko Wilcox-O'Hearn
82579cec96
magic first line tells emacs to use utf8+bom
...
Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
2013-11-08 21:08:05 +00:00
Daira Hopwood
2ac43975ee
Fix typo pointed out by CptPlastic.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-10-22 02:31:52 +01:00
Brian Warner
17fcafbb3f
docs: replace emdash characters with plain ASCII
2013-04-09 20:19:58 +01:00
David-Sarah Hopwood
a77ae772f2
docs/about.rst: fix broken link for network-and-reliance-topology image.
...
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2012-11-01 23:09:07 +00:00
david-sarah
e215af8646
Update copyright notices. refs #1686
2012-03-13 20:50:57 +00:00
Zooko O'Whielacronx
0ac4801293
docs: an extra newline to separate utf-8 BOF from comment for the sake of trac's rst renderer
2012-01-22 21:20:02 +00:00
Zooko O'Whielacronx
d23de91e2e
docs: a newline between the utf-8 BOF and the comment in order to prevent trac from misrendering the comment
...
sheesh
2012-01-22 21:18:56 +00:00
Zooko O'Whielacronx
4e4f3cadf9
docs: a comment to inform the (human) reader about encoding and to prevent someone from moving the title up to where it will interact with the utf-8 BOM and cause trac to mis-render the title
2012-01-22 21:17:31 +00:00
Zooko O'Whielacronx
28bfccaefc
docs: insert another newline between utf-8 BOF and title
2012-01-22 21:14:27 +00:00
Zooko O'Whielacronx
f9a756763c
docs: insert newline after utf-8 BOF and before restructuredtext title
2012-01-22 18:21:27 +00:00
Zooko O'Whielacronx
7db661fe1b
docs: try again to change RestructuredText titles to a format that trac will render
2012-01-22 13:56:13 +00:00
Zooko O'Whielacronx
4a29642623
doc: about.rst: use unicode emdash, use non-embedded URIs, add clarificaiton of when a file gets its mutable-or-immutable nature
...
embedded URIs, although documented here:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris
generate messages like this from rst2html --verbose:
quickstart.rst:3: (INFO/1) Duplicate explicit target name: "the tahoe-dev mailing list".
Also this patch prepends a "utf-8 BOM" to the beginning of the file.
2011-12-06 17:19:08 +00:00
Brian Warner
52a9523d7a
and about.rst
2011-10-29 19:58:16 +00:00
david-sarah
f8be1f6220
docs/about.rst: correct the description of availability to take into account that shares may not be stored on distinct servers.
2011-10-25 06:25:50 -07:00
Zooko O'Whielacronx
f1897a3da1
docs: change links that pointed to COPYING.TGPPL.html to point to COPYING.TGPPL.rst instead
2011-08-18 23:01:42 -07:00
Zooko O'Whielacronx
74e83bba9f
docs: formatting: reflow to fill-column 77
2011-08-18 23:01:10 -07:00
Zooko O'Whielacronx
3c711a8375
docs: formatting: M-x whitespace-cleanup
2011-08-18 23:00:41 -07:00
Zooko O'Whielacronx
299e8ad579
replace remaining .html docs with .rst docs
...
Remove install.html (long since deprecated).
Also replace some obsolete references to install.html with references to quickstart.rst.
Fix some broken internal references within docs/historical/historical_known_issues.txt.
Thanks to Ravi Pinjala and Patrick McDonald.
refs #1227
2011-05-10 12:16:50 -07:00
