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
Zooko Wilcox-O'Hearn
0bebbe3290
fix warnings from rst2html
...
Apparently the in-line link syntax with "<>" in them causes these warnings. I
don't know why. I changed them all to a slightly more verbose syntax.
Thanks to Mike Kazantzsev's review comment
(https://github.com/tahoe-lafs/tahoe-lafs/pull/67#commitcomment-4561370 ), I
moved the links to the end of each section.
2013-11-11 22:04:11 +00: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
397a95e827
Update terminology in RAIC design doc.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-05-01 22:58:16 +01:00
Brian Warner
17fcafbb3f
docs: replace emdash characters with plain ASCII
2013-04-09 20:19:58 +01:00
david-sarah
514fb096be
Update docs, notably performance.rst, to include MDMF. fixes #1772
2012-06-23 23:13:38 +00:00
Patrick R McDonald
2f9f853413
Added docs/specifications/backends/raic.rst for ticket #1760
2012-06-10 12:32:36 -07:00
Brian Warner
890b694dd2
add user-oriented notes to NEWS and mutable.rst about SDMF-vs-MDMF
2011-10-30 20:05:12 -07:00
david-sarah
4861d50c2f
docs: some changes of 'delete' or 'rm' to 'unlink'. refs #1104
2011-07-12 17:27:22 -07:00
Zooko O'Whielacronx
ed836157aa
docs: fix error in crypto specification that was noticed by Taylor R Campbell <campbell+tahoe@mumble.net>
2011-06-29 11:57:11 -07:00
david-sarah
45dd8b910a
docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API.
2010-12-26 21:05:33 -08:00
david-sarah
5f73c27b23
Fix a link from uri.rst to dirnodes.rst. refs #1225
2010-12-11 21:45:02 -08:00
david-sarah
5d612c87ab
Update hyperlinks between docs, and linkify some external references. refs #1225
2010-12-11 21:14:59 -08:00
david-sarah
458b2de08b
docs/specifications/dirnodes.rst: fix references to mutable.rst. refs #1225
2010-12-11 17:27:20 -08:00
david-sarah
7da1885531
docs/specifications/mutable.rst: correct the magic string for v1 mutable containers. refs #1225
2010-12-11 17:14:00 -08:00
david-sarah
1d5c705201
Move .txt files in docs/frontends and docs/specifications to .rst. refs #1225
2010-12-11 17:02:51 -08:00
david-sarah
2100273ce3
Convert docs/frontends and docs/specifications to reStructuredText format (not including file moves).
2010-12-11 16:46:32 -08:00
david-sarah
e3b58b1e88
docs/specifications/dirnodes.txt: 'mesh'->'grid'.
2010-07-22 23:16:16 -07:00
david-sarah
497925317e
docs/specifications/dirnodes.txt: bring layer terminology up-to-date with architecture.txt, and a few other updates (e.g. note that the MAC is no longer verified, and that URIs can be unknown). Also 'Tahoe'->'Tahoe-LAFS'.
2010-07-22 22:47:03 -07:00
david-sarah
a92a23fe34
configuration.txt and servers-of-happiness.txt: 1 <= happy <= N, not k <= happy <= N. Also minor wording changes.
2010-06-17 22:07:10 -07:00
Kevan Carstensen
7cadb49b88
Add a specification for servers of happiness.
2010-05-23 17:35:08 -07:00
Brian Warner
7ef99c5e33
CHK-hashes.svg: cross out plaintext hashes, since we don't include
...
them (until we finish #453 )
2009-10-04 18:08:03 -07:00
Zooko O'Whielacronx
a19c5e659e
docs: network-and-reliance-topology.svg: nicer server icons, mv out of the "specifications" subdir
2009-05-26 09:58:42 -07:00
Zooko O'Whielacronx
1e77e961a2
docs: update network-and-reliance-topology.svg
2009-05-26 09:31:05 -07:00
Zooko O'Whielacronx
e7e13958c2
docs: add a diagram that I'm about to show to the Boulder Linux Users Group: network-and-reliance-topology.svg
2009-05-14 16:20:59 -07:00
Zooko O'Whielacronx
a2f34b4e1a
docs: a few edits/updates about dirnodes
2009-04-13 09:08:37 -07:00
Zooko O'Whielacronx
9729753692
dirnode: add 'tahoe'/'linkcrtime' and 'tahoe'/'linkmotime' to take the place of what 'mtime'/'ctime' originally did, and make the 'tahoe' subdict be unwritable through the set_children API
...
Also add extensive documentation in docs/frontends/webapi.txt about the behaviors of these values. See ticket #628 .
2009-04-11 15:52:05 -07:00
Brian Warner
4ab3397992
docs: move many specification-like documents into specifications/
2009-02-21 23:40:54 -07:00
Brian Warner
bbef104315
docs/specifications: add an outline of the spec documents we'd like to have some day
2009-02-08 17:47:48 -07:00
