aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWill Kahn-Greene <willg@bluesock.org>2011-07-30 16:25:44 -0400
committerWill Kahn-Greene <willg@bluesock.org>2011-07-30 16:26:43 -0400
commitd4535719370ca3be4790070e4bbe572671ba6045 (patch)
treebe506ea62de5c0167eeff8d2ffb546453607d653
parent482d53cd30229798ff58f9d6f3cbb3b86f94f218 (diff)
downloadmediagoblin-d4535719370ca3be4790070e4bbe572671ba6045.tar.lz
mediagoblin-d4535719370ca3be4790070e4bbe572671ba6045.tar.xz
mediagoblin-d4535719370ca3be4790070e4bbe572671ba6045.zip
460. Adds texinfo output bits
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.
-rw-r--r--docs/Makefile21
-rw-r--r--docs/conf.py23
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 81fc3d13..9a4608de 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -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
diff --git a/docs/conf.py b/docs/conf.py
index 6c64cdda..a7acd3e2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -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'