| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
| |
All of rst_source/ is now just in doc/.
The krb_ prefix is stripped from the document sub-directories.
rst_tools are now just tools.
The section headers of kadmind, krb5kdc, and sserver match as conflict markers.
bigredbutton: whitespace
ticket: 7409
|
| | |
|
| |
|
|
|
|
|
| |
Fix a couple of grammar errors noted by Ben Kaduk, and elaborate a
little bit on why generated man pages are checked into the repository.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25798 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
|
|
|
|
|
|
| |
Add a new target "substhtml" in src/doc to create HTML documentation
with configured paths, suitable for installation by an OS package.
The build target generates a file named paths.py containing the
directory substitutions, copies it into the rst_composite directory,
and instructs conf.py to use it with the "pathsubs" tag.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25795 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
|
|
|
| |
rstman makes more sense in man than in doc, so move it there. Remove
the rstman target from the top-level doc Makefile to avoid confusion.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25792 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
|
|
|
|
|
| |
In src/doc/Makefile.in, create an "rsthtml" target for generating
release tarball/web site HTML docs in doc/rst_html. For now,
eliminate support for the bridge to the Doxygen HTML output; just
generate XML output with Doxygen and convert it to RST format.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25791 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
|
|
| |
(such as Kerberos V5 Installation Guide etc) in the rst files
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25787 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
| |
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25750 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
| |
|
|
| |
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25434 dc483132-0cff-0310-8789-dd5450dbe970
|
| |
|
|
| |
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25423 dc483132-0cff-0310-8789-dd5450dbe970
|
|
|
One can build Sphinx documentation set in the html format by calling:
sphinx-build sourcedir builddir
For example:
sphinx-build ./rst_source /tmp/build
Note: This commit does not include the "Complete Reference - API and datatypes". This results into partial disabling of the function cross-referencing enhancement in the generated documentation.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24981 dc483132-0cff-0310-8789-dd5450dbe970
|
