diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-11-06 22:15:50 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-11-14 15:31:13 -0500 |
| commit | ccaf2682c79974cee368d2f3b0611dabc1361df5 (patch) | |
| tree | bf852491bce076326a300a3494fccb8dc0809562 /doc/tools | |
| parent | 07b66c2220ad1b38c5465cacc2537096afe332d2 (diff) | |
| download | krb5-ccaf2682c79974cee368d2f3b0611dabc1361df5.tar.gz krb5-ccaf2682c79974cee368d2f3b0611dabc1361df5.tar.xz krb5-ccaf2682c79974cee368d2f3b0611dabc1361df5.zip | |
Rename doc subdirectories
We like these names better, and they match the PDF document filenames.
admins -> admin
appldev -> appdev
users -> user
and catch up where the names are used elsewhere.
The relay/ directory has been removed, with its contents moved to the
top level in build_this.rst and a new about.rst.
The section headers for kadmind, krb5kdc, sserver, kpasswd, kswitch,
and sclient are misdetected as conflict markers.
bigredbutton: whitespace
ticket: 7433
tags: pullup
Diffstat (limited to 'doc/tools')
| -rw-r--r-- | doc/tools/README | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/tools/README b/doc/tools/README index 377690d17b..ccbed6cf9a 100644 --- a/doc/tools/README +++ b/doc/tools/README @@ -31,14 +31,14 @@ Part A: Transforming Doxygen XML output into reStructuredText (rst) without python doxy.py –i doxy_xml_dir –o rst_dir -t all converts Doxygen XML output into reStructuredText format files both for API functions and data types; -4. In appldev/index.rst add the following section to point to the API references: +4. In appdev/index.rst add the following section to point to the API references: .. toctree:: :maxdepth: 1 refs/index.rst -5. Copy the content of rst_dir into appldev/refs/api/ directory and rst_dir/types into appldev/refs/types directory; +5. Copy the content of rst_dir into appdev/refs/api/ directory and rst_dir/types into appdev/refs/types directory; 6. Rebuild Sphinx source: sphinx-build source_dir build_dir |