Mercurial > p > roundup > code

annotate doc/index.txt @ 6160:9619d64c0351

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc updates for customizing.txt, start of index generation customizing.txt: fix doc on schema.py. Documented obsolete db schema declaration/initial data method. doc on config.ini is incomplete. doc as such. Add doc for [rdbms]: backend, cache_size, sqlite_timeout document Interval schema type. Also change formatting for list of schema types to description list from regular list so types are more visible. add link to roundup wiki for schema chnge examples. fix formatting for postfix config. document Rest Access and Xmlrpc Access permissions; change classic schema.py example to include them. doc db/backend_name as obsolete, conf.py [rdbms] backend used instead. start adding index references conf.py: update copyright year index.txt: add link to genindex.html. _templates/layout.html: change code to make index output work. Not sure what the change does, just monkey pasting from sphinx basic/layout.html
author John Rouillard <rouilj@ieee.org>
date Mon, 11 May 2020 00:02:31 -0400
parents 7cf8f6389aad
children b2eb59ada444
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
686
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
1 =======================================================
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
2 Roundup: an Issue-Tracking System for Knowledge Workers
c52122f38c9b Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents: 659
diff changeset
3 =======================================================
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
4610
e793eafba69c Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents: 4440
diff changeset
5 For how to contact the community see http://www.roundup-tracker.org .
e793eafba69c Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents: 4440
diff changeset
6
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 Contents
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 ========
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
10 .. toctree::
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
11 :maxdepth: 2
659
e429649ed124 More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
13 features
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
14 installation
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
15 upgrading
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
16 FAQ
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
17 user_guide
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
18 customizing
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
19 admin_guide
5078
487dc55e3c5e issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents: 4890
diff changeset
20 debugging
4440
7c576a4dea9d XML-RPC documentation now linked from the docs/index
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 4033
diff changeset
21 xmlrpc
5695
3e1b66c4e1e2 Update docs. Correct errors reported by setup.py build_docs. Add rest
John Rouillard <rouilj@ieee.org>
parents: 5078
diff changeset
22 rest
5078
487dc55e3c5e issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents: 4890
diff changeset
23 overview
4890
609edf9de0a5 docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents: 4746
diff changeset
24 Design (original) <design>
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
25 developers
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
26 tracker_templates
5078
487dc55e3c5e issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents: 4890
diff changeset
27 Notes about the MySQL Database backend <mysql>
487dc55e3c5e issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents: 4890
diff changeset
28 Notes about the PostgreSQL Database backend <postgresql>
4746
25fcb87a8301 Link glossary to the documentation contents.
anatoly techtonik <techtonik@gmail.com>
parents: 4610
diff changeset
29 glossary
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
30 acknowledgements
5078
487dc55e3c5e issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents: 4890
diff changeset
31 Richard Jones implementation notes <implementation>
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents: 4000
diff changeset
32 license
5925
7cf8f6389aad issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents: 5695
diff changeset
33
7cf8f6389aad issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents: 5695
diff changeset
34 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
7cf8f6389aad issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents: 5695
diff changeset
35 documentation.
6160
9619d64c0351 Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents: 5925
diff changeset
36
9619d64c0351 Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents: 5925
diff changeset
37 Indices
9619d64c0351 Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents: 5925
diff changeset
38 =======
9619d64c0351 Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents: 5925
diff changeset
39
9619d64c0351 Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents: 5925
diff changeset
40 * :ref:`genindex`
Roundup Issue Tracker: http://roundup-tracker.org/