diff options
Diffstat (limited to 'src/doc/Makefile.in')
| -rw-r--r-- | src/doc/Makefile.in | 62 |
1 files changed, 42 insertions, 20 deletions
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 |