diff options
| author | Greg Hudson <ghudson@mit.edu> | 2012-02-26 16:45:09 +0000 |
|---|---|---|
| committer | Greg Hudson <ghudson@mit.edu> | 2012-02-26 16:45:09 +0000 |
| commit | 1acc419ac66c4b6183d113351245b530f8219d00 (patch) | |
| tree | 8f53f9e47e3457fbde7bb726de1d07acb2ac30f8 /src/plugins/locate/python/python.exports | |
| parent | 2c990e6418cd7cee7ca178a3175b07ed6a01ffae (diff) | |
| download | krb5-1acc419ac66c4b6183d113351245b530f8219d00.tar.gz krb5-1acc419ac66c4b6183d113351245b530f8219d00.tar.xz krb5-1acc419ac66c4b6183d113351245b530f8219d00.zip | |
Format pass over RST documentation
Without substantially changing the content, reformat RST
documentation sources, normalizing:
* Whitespace: four-space indentation where indentation is arbitrary;
no trailing whitespace or tabs. Two spaces after sentence periods.
* 70-column fill where lines can be wrapped (outside tables, mostly)
* Section header underlines: = for page titles, - for sections, ~ and
then # for subsections. Underlines exactly as long as titles. No
trailing punctuation in titles.
* Bullet lists: * for top-level bullets, - for sub-bullets. No
indentation of the list bullets relative to the surrounding content.
* Inline markup: italics for words representing variable text,
boldface for config keywords and command option names, monospaced
text for examples, pathnames. No adornment for command names and
filenames.
* Man page subcommands: subsection header for the subcommand, indented
command synposis, then non-indented description and option list.
* Man page command synopses: newline in source before each option. All
parts of synopsis at same indentation level. (Ideally we'd want a
hanging indent to the length of the command name, but RST doesn't
seem to support that.)
* Feedback links: in a separate section at the end. (This will need
to be revisited as it affects some multi-level tables of contents.)
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25712 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src/plugins/locate/python/python.exports')
0 files changed, 0 insertions, 0 deletions
