diff doc/customizing.txt @ 6163:c2fd254c9257

Doc updates/indexing. doc/admin_guide.txt, doc/customizing.txt, doc/features.txt, doc/installation.txt, doc/mysql.txt, doc/postgresql.txt: adding index entries doc/customizing.txt: reference schema changes later in document in addition to wiki. website/www/contents.txt: make wiki url https:.... Remove indices/tables as they don't show up in web interface. Put docs/announcement.txt into hidden toctree to silence warning from sphinx. Announcement.txt is referenced from index.txt so can't silence by adding to conf.py exclude_patern. website/www/index.txt: mention security and other improvements in jinja2 templates. website/www/conf.py: get rid of all warning by using exclude_patterns to ignore docs that aren't included. Remove exclude_trees using exclude_pattern instead. Make html_add_permalinks value acceptable so no warning reported. website/www/_static/style.css, website/www/_templtes/layout.html: add prev/next/index links for all doc pages.
author John Rouillard <rouilj@ieee.org>
date Wed, 13 May 2020 00:40:14 -0400
parents 9619d64c0351
children de9d602c8ce6
line wrap: on
line diff
--- a/doc/customizing.txt	Mon May 11 11:12:25 2020 -0400
+++ b/doc/customizing.txt	Wed May 13 00:40:14 2020 -0400
@@ -68,7 +68,9 @@
 automatically register through the email interface, you must grant the
 "Anonymous" Role the "Email Access" Permission.
 
-.. index:: configuration; sections
+.. index::
+   single: config.ini; sections
+   see: configuration; config.ini
 
 The following is taken from the `Python Library Reference`__ (July 18, 2018)
 section "ConfigParser -- Configuration file parser":
@@ -236,6 +238,16 @@
  addition settings needed by RDBMs like SQLite, Postgresql and
  MySQL backends.
 
+ .. index::
+    single: postgres; select backend in config.ini 
+    single: mysql; select backend in config.ini
+    single: sqlite; select backend in config.ini
+    single: anydbm; select backend in config.ini
+    see: database; postgres
+    see: database; mysql
+    see: database; sqlite
+    see: database; anydbm
+
  backend -- set to value by init
   The database backend such as anydbm, sqlite, mysql or postgres.
 
@@ -263,6 +275,9 @@
   Name of the group to use in the MySQL defaults file. Only used in
   MySQL connections.
 
+ .. index::
+    single: sqlite; lock timeout
+
  sqlite_timeout -- ``30``
   Number of seconds to wait when the SQLite database is locked.
   Used only for SQLite.
@@ -487,6 +502,11 @@
   download page for the file.
 
 
+.. index:: single: roundup-admin; config.ini update
+           single: roundup-admin; config.ini create
+           single: config.ini; create
+           single: config.ini; update
+
 You may generate a new default config file using the ``roundup-admin
 genconfig`` command. You can generate a new config file merging in
 existing settings using the ``roundup-admin updateconfig`` command.
@@ -523,7 +543,7 @@
 
 then the above ``db.config.detectors['QA_RECIPIENTS']`` will still work.
 
-.. index:: schema
+.. index:: ! schema
 
 Tracker Schema
 ==============
@@ -995,12 +1015,15 @@
 Examples of adding to your schema
 ---------------------------------
 
-The `Roundup wiki`_ has examples of
-how schemas can be customised to add new functionality.
+Some examples are in the :ref:`CustomExamples` section below.
+
+Also the `Roundup wiki`_ has additional examples of how schemas can be
+customised to add new functionality.
 
 .. _Roundup wiki:
    https://wiki.roundup-tracker.org/
 
+.. index:: !detectors
 
 Detectors - adding behaviour to your tracker
 ============================================
@@ -1017,6 +1040,8 @@
 detectors or modify the existing ones. The existing detectors installed
 for you are:
 
+.. index:: detectors; installed
+
 **nosyreaction.py**
   This provides the automatic nosy list maintenance and email sending.
   The nosy reactor (``nosyreaction``) fires when new messages are added
@@ -1045,6 +1070,8 @@
 __ design.html
 
 
+.. index:: detectors; writing api
+
 Detector API
 ------------
 
@@ -1082,6 +1109,7 @@
 For a ``retire()`` or ``restore()`` operation, ``itemid`` is the id of
 the retired or restored item and ``olddata`` is None.
 
+.. index:: detectors; additional
 
 Additional Detectors Ready For Use
 ----------------------------------
@@ -1612,6 +1640,9 @@
     #   db.security.addPermissionToRole('Anonymous', 'Create', cl)
     #   db.security.addPermissionToRole('Anonymous', 'Edit', cl)
 
+.. index::
+   single: roundup-admin; class permissions
+
 You can use ``roundup-admin security`` to verify the permissions
 defined in the schema. It also verifies that properties specified in
 permissions are valid for the class. This helps detect typos that can
@@ -3755,6 +3786,7 @@
 
 The charset is also sent in the http header.
 
+.. _CustomExamples:
 
 Examples
 ========
@@ -3783,6 +3815,8 @@
 tracker access (note that roundup-server would need to be restarted as it
 caches the schema).
 
+.. index:: schema; example changes
+
 1. Modify the ``schema.py``::
 
     issue = IssueClass(db, "issue", 
@@ -4282,6 +4316,8 @@
 
     db.security.addPermissionToRole('User', 'Edit', 'timelog')
 
+.. index:: schema; example changes
+
 2. Link to the new class from your issue class (again, in
    ``schema.py``)::
 

Roundup Issue Tracker: http://roundup-tracker.org/