460. Adds texinfo output bits
authorWill Kahn-Greene <willg@bluesock.org>
Sat, 30 Jul 2011 20:25:44 +0000 (16:25 -0400)
committerWill Kahn-Greene <willg@bluesock.org>
Sat, 30 Jul 2011 20:26:43 +0000 (16:26 -0400)
Building texinfo version of the manual only works with Sphinx from hg
tip at present.

Also, there are some minor issues and someone should go through the
manual and read it to make sure there aren't issues.

docs/Makefile
docs/conf.py

index 81fc3d136b1e4daf86672e401681e4f4f5df41db..9a4608de548a39189e7a91d86d71610faf5e718d 100644 (file)
@@ -12,6 +12,9 @@ PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
 help:
@@ -113,6 +116,24 @@ man:
        @echo
        @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
+texinfo:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo
+       @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+       @echo "Run \`make' in that directory to run these through makeinfo" \
+             "(use \`make info' here to do that automatically)."
+
+info:
+       $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+       @echo "Running Texinfo files through makeinfo..."
+       make -C $(BUILDDIR)/texinfo info
+       @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+       $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+       @echo
+       @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
 changes:
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
        @echo
index 6c64cddaea72ef86aa47a86e510f12b47a59dc6d..a7acd3e2bc0c4e7c90ee1b4aff2013e87db4cfc9 100644 (file)
@@ -214,3 +214,26 @@ man_pages = [
     ('index', 'gnumediagoblin', u'GNU MediaGoblin Documentation',
      [u'Chris Webber, et al'], 1)
 ]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'gnumediagoblin', u'GNU MediaGoblin Documentation', u'gnumediagoblin',
+   'GNU MediaGoblin', 'Media sharing web application.', 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'