diff options
| author | Greg Hudson <ghudson@mit.edu> | 2012-03-28 21:11:06 +0000 |
|---|---|---|
| committer | Greg Hudson <ghudson@mit.edu> | 2012-03-28 21:11:06 +0000 |
| commit | ad10a94d11676da906feb0d8b9394c5b2ed394aa (patch) | |
| tree | 7b7baa73fa637d3365a2193b7b0f68a8de890486 /src/doc/Makefile.in | |
| parent | dd19c21d26e80d9e6e622353ec4cf2e073da04b0 (diff) | |
| download | krb5-ad10a94d11676da906feb0d8b9394c5b2ed394aa.tar.gz krb5-ad10a94d11676da906feb0d8b9394c5b2ed394aa.tar.xz krb5-ad10a94d11676da906feb0d8b9394c5b2ed394aa.zip | |
Add doc target with configured path substitutions
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
Diffstat (limited to 'src/doc/Makefile.in')
| -rw-r--r-- | src/doc/Makefile.in | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/src/doc/Makefile.in b/src/doc/Makefile.in index ed3122082..95ece80e2 100644 --- a/src/doc/Makefile.in +++ b/src/doc/Makefile.in @@ -5,6 +5,8 @@ SPHINX_BUILD=sphinx-build DOXYGEN=doxygen docsrc=$(top_srcdir)/../doc +localstatedir=@localstatedir@ +sysconfdir=@sysconfdir@ # Create HTML documentation in $(docsrc)/rst_html suitable for a # release tarball or the web site (that is, without substitutions for @@ -16,10 +18,18 @@ rsthtml: composite rm -rf $(docsrc)/rst_html $(SPHINX_BUILD) -q rst_composite $(docsrc)/rst_html +# Create HTML documentation in rst_html_subst suitable for +# installation by an OS package, with substitutions for configured +# paths. +substhtml: composite paths.py + rm -rf rst_html_subst + cp paths.py rst_composite + $(SPHINX_BUILD) -t pathsubs -q rst_composite rst_html_subst + # Use doxygen to generate API documentation, translate it into RST # format, and then create a composite of $(docsrc)/rst_source, the # generated files, and the NOTICE file in rst_composite. Used by the -# rsthtml and ___ targets. +# rsthtml and substhtml targets. composite: Doxyfile rm -rf doxy rst_apiref rst_composite $(DOXYGEN) @@ -35,5 +45,13 @@ Doxyfile: $(srcdir)/Doxyfile.in sed -e 's|@SRC@|$(top_srcdir)|g' \ -e 's|@DOC@|$(top_srcdir)/../doc|g' $(srcdir)/Doxyfile.in > $@ +paths.py: + rm -f $@ + echo 'bindir = "``$(CLIENT_BINDIR)``"' > $@ + echo 'sbindir = "``$(SERVER_BINDIR)``"' >> $@ + echo 'libdir = "``$(KRB5_LIBDIR)``"' >> $@ + echo 'localstatedir = "``$(localstatedir)``"' >> $@ + echo 'sysconfdir = "``$(sysconfdir)``"' >> $@ + clean:: - rm -rf doxy rst_apiref rst_composite Doxyfile + rm -rf doxy rst_apiref rst_composite rst_html_subst Doxyfile paths.py |