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 | |
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
-rw-r--r-- | .gitignore | 4 | ||||
-rw-r--r-- | doc/index.rst | 12 | ||||
-rw-r--r-- | doc/relay/build_this.rst | 8 | ||||
-rw-r--r-- | src/doc/Makefile.in | 62 |
4 files changed, 54 insertions, 32 deletions
diff --git a/.gitignore b/.gitignore index 218800fb81..d1b4bbac63 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,7 @@ obj/ testdir/ testlog -/doc/rst_html/ +/doc/html/ /src/config.log /src/config.status @@ -57,7 +57,7 @@ testlog /src/doc/paths.py /src/doc/rst_apiref/ /src/doc/rst_composite/ -/src/doc/rst_html_subst/ +/src/doc/html_subst/ /src/include/autoconf.h /src/include/autoconf.h.in 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 diff --git a/src/doc/Makefile.in b/src/doc/Makefile.in index e961f902a0..b6a3defdbd 100644 --- a/src/doc/Makefile.in +++ b/src/doc/Makefile.in @@ -11,23 +11,41 @@ DEFCCNAME=@DEFCCNAME@ DEFKTNAME=@DEFKTNAME@ DEFCKTNAME=@DEFCKTNAME@ -# Create HTML documentation in $(docsrc)/rst_html suitable for a +RST_SOURCES= _static \ + _templates \ + conf.py \ + index.rst \ + admins \ + appldev \ + basic \ + build \ + plugindev \ + users \ + mitK5defaults.rst \ + mitK5features.rst \ + mitK5license.rst \ + notice.rst \ + relay \ + resources.rst \ + txt_conf.py + +# Create HTML documentation in $(docsrc)/html suitable for a # release tarball or the web site (that is, without substitutions for # configured paths). This can be done in an unconfigured source tree # with: -# make -f Makefile.in srcdir=. top_srcdir=.. PYTHON=python rsthml +# make -f Makefile.in srcdir=. top_srcdir=.. PYTHON=python html # make -f Makefile.in clean -rsthtml: composite - rm -rf $(docsrc)/rst_html - $(SPHINX_BUILD) -q rst_composite $(docsrc)/rst_html +html: rst_composite + rm -rf $(docsrc)/html + $(SPHINX_BUILD) -q rst_composite $(docsrc)/html -# Create HTML documentation in rst_html_subst suitable for +# Create HTML documentation in html_subst suitable for # installation by an OS package, with substitutions for configured # paths. -substhtml: composite paths.py - rm -rf rst_html_subst +substhtml: rst_composite paths.py + rm -rf html_subst cp paths.py rst_composite - $(SPHINX_BUILD) -t pathsubs -q rst_composite rst_html_subst + $(SPHINX_BUILD) -t pathsubs -q rst_composite html_subst # Create an ASCII (okay, UTF-8) version of the NOTICE file notice.txt: rst_notice @@ -37,17 +55,21 @@ NOTICE: notice.txt cp notice.txt $(top_srcdir)/../NOTICE # Use doxygen to generate API documentation, translate it into RST -# format, and then create a composite of $(docsrc)/rst_source and the -# generated files in rst_composite. Used by the rsthtml and substhtml targets. -composite: Doxyfile +# format, and then create a composite of $(docsrc)'s RST and the +# generated files in rst_composite. Used by the html and substhtml targets. +rst_composite: Doxyfile rm -rf doxy rst_apiref rst_composite $(DOXYGEN) - cwd=`pwd`; cd $(docsrc)/rst_tools && \ + cwd=`pwd`; cd $(docsrc)/tools && \ $(PYTHON) doxy.py -i $$cwd/doxy/xml -o $$cwd/rst_apiref - cp -r $(docsrc)/rst_source rst_composite - cp rst_apiref/*.rst rst_composite/krb_appldev/refs/api - cp rst_apiref/types/*.rst rst_composite/krb_appldev/refs/types - cp rst_apiref/macros/*.rst rst_composite/krb_appldev/refs/macros + mkdir -p rst_composite + do_subdirs="$(RST_SOURCES)" ; \ + for i in $$do_subdirs; do \ + cp -r $(docsrc)/$$i rst_composite; \ + done + cp rst_apiref/*.rst rst_composite/appldev/refs/api + cp rst_apiref/types/*.rst rst_composite/appldev/refs/types + cp rst_apiref/macros/*.rst rst_composite/appldev/refs/macros # Must use a separate source dir for sphinx text builds, since the text # engine cannot handle the row spanning cells in fancy tables that we use @@ -55,8 +77,8 @@ rst_notice: $(docsrc)/notice.rst $(docsrc)/txt_conf.py mkdir -p rst_notice # reST needs backslashes before parens in this macro definition. sed -e 's/include:: <isonum.txt>/|copy| replace:: \\(C\\)/' \ - < $(docsrc)/rst_source/notice.rst > rst_notice/notice.rst - cp $(docsrc)/rst_source/txt_conf.py rst_notice/conf.py + < $(docsrc)/notice.rst > rst_notice/notice.rst + cp $(docsrc)/txt_conf.py rst_notice/conf.py Doxyfile: $(srcdir)/Doxyfile.in sed -e 's|@SRC@|$(top_srcdir)|g' \ @@ -74,5 +96,5 @@ paths.py: echo 'ckeytab = "``$(DEFCKTNAME)``"' >> $@ clean:: - rm -rf doxy rst_apiref rst_composite rst_notice rst_html_subst \ + rm -rf doxy rst_apiref rst_composite rst_notice html_subst \ Doxyfile paths.py |