diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-10-15 18:17:50 -0400 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-10-15 19:22:21 -0400 |
| commit | 970fc63c63c13a9a15fd0c6dcb6ba7a11ab63c36 (patch) | |
| tree | 1ad37caf1d3e3cafd629a123929b60e97d307d9a /doc | |
| parent | e95f9f6875f4cbcae60fe96696eb83a6972bbf26 (diff) | |
| download | krb5-970fc63c63c13a9a15fd0c6dcb6ba7a11ab63c36.tar.gz krb5-970fc63c63c13a9a15fd0c6dcb6ba7a11ab63c36.tar.xz krb5-970fc63c63c13a9a15fd0c6dcb6ba7a11ab63c36.zip | |
Catch up to RST move/rename
Change the make rules for the directory structure.
Update the RST sources which include other RST sources for the
loss of the krb_ prefix.
ticket: 7409
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.rst | 12 | ||||
| -rw-r--r-- | doc/relay/build_this.rst | 8 |
2 files changed, 10 insertions, 10 deletions
diff --git a/doc/index.rst b/doc/index.rst index fb1012bc1e..157a5df00c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,12 +5,12 @@ MIT Kerberos Documentation .. toctree:: :maxdepth: 1 - krb_users/index.rst - krb_admins/index.rst - krb_appldev/index.rst - krb_plugindev/index.rst - krb_build/index.rst - krb_basic/index.rst + users/index.rst + admins/index.rst + appldev/index.rst + plugindev/index.rst + build/index.rst + basic/index.rst mitK5features.rst relay/index.rst resources diff --git a/doc/relay/build_this.rst b/doc/relay/build_this.rst index f51d1047df..6244983634 100644 --- a/doc/relay/build_this.rst +++ b/doc/relay/build_this.rst @@ -20,7 +20,7 @@ To test simple changes to the RST sources, you can build the documentation without the Doxygen reference by running, from the doc directory:: - sphinx-build rst_source test_html + sphinx-build . test_html You will see a number of warnings about missing files. This is expected. @@ -47,10 +47,10 @@ files when rebuilding the man pages. Building for a release tarball or web site ------------------------------------------ -To generate documentation in HTML format, run ``make rsthtml`` in the +To generate documentation in HTML format, run ``make html`` in the ``doc`` subdirectory of a configured build tree (the build directory corresponding to ``src/doc``, not the top-level ``doc`` directory). -The output will be placed in the top-level ``doc/rst_html`` directory. +The output will be placed in the top-level ``doc/html`` directory. This build will include the API reference generated from Doxygen markup in the source tree. @@ -73,7 +73,7 @@ To generate documentation specific to a build of MIT krb5 as you have configured it, run ``make substhtml`` in the ``doc`` subdirectory of a configured build tree (the build directory corresponding to ``src/doc``, not the top-level ``doc`` directory). The output will be -placed in the ``rst_html_subst`` subdirectory of that build directory. +placed in the ``html_subst`` subdirectory of that build directory. This build will include the API reference. Documentation generated this way will use concrete paths (like |