summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2012-11-09 09:00:27 +0100
committerClaude Paroz <claude@2xlibre.net>2012-11-09 09:03:52 +0100
commit087274d08f40b7d3e37a6d138789bd4ec4903139 (patch)
treec2eacfed92c6b4e8a83f9b8af903f8e3077bac31 /docs
parent908226cf1acb6c4029d73318a0aaa923f58c9157 (diff)
[1.5.x] Fixed #19266 -- Added Texinfo documentation target
Thanks orontee for the report and initial patch. Backport of a79d920a56 from master.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile6
-rw-r--r--docs/conf.py10
-rw-r--r--docs/make.bat9
3 files changed, 25 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
index bdf48549a3..f6293a8e7f 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -31,6 +31,7 @@ help:
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
+ @echo " texinfo to make a Texinfo source file"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@@ -116,6 +117,11 @@ 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."
+
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
diff --git a/docs/conf.py b/docs/conf.py
index 65f4f1ae8e..ddb31d04d4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -233,6 +233,16 @@ man_pages = [
]
+# -- Options for Texinfo output ------------------------------------------------
+
+# List of tuples (startdocname, targetname, title, author, dir_entry,
+# description, category, toctree_only)
+texinfo_documents=[(
+ master_doc, "django", "", "", "Django",
+ "Documentation of the Django framework", "Web development", False
+)]
+
+
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
diff --git a/docs/make.bat b/docs/make.bat
index d6299521eb..d7f54b2059 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -29,6 +29,7 @@ if "%1" == "help" (
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
+ echo. texinfo to make a Texinfo source file
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
@@ -143,6 +144,14 @@ if "%1" == "man" (
goto end
)
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
if "%%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1