summaryrefslogtreecommitdiffstats
path: root/Doc/tools
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-01-16 20:27:56 (GMT)
committerGeorg Brandl <georg@python.org>2008-01-16 20:27:56 (GMT)
commit7155a09c444a9e6229c7387468265b505680ff51 (patch)
tree3322c9e82cd45d7e595f7cc85034c48e3d719061 /Doc/tools
parent415c1e36a9f3cb119fad8aa5fcdcc9f31284782e (diff)
downloadcpython-7155a09c444a9e6229c7387468265b505680ff51.zip
cpython-7155a09c444a9e6229c7387468265b505680ff51.tar.gz
cpython-7155a09c444a9e6229c7387468265b505680ff51.tar.bz2
Add Python-specific content to Doc dir. Update configuration file
to work with the newest Sphinx.
Diffstat (limited to 'Doc/tools')
-rw-r--r--Doc/tools/sphinx-build.py16
-rw-r--r--Doc/tools/sphinxext/download.html53
-rw-r--r--Doc/tools/sphinxext/indexcontent.html56
-rw-r--r--Doc/tools/sphinxext/indexsidebar.html19
4 files changed, 136 insertions, 8 deletions
diff --git a/Doc/tools/sphinx-build.py b/Doc/tools/sphinx-build.py
index 8f952be..ed2366b 100644
--- a/Doc/tools/sphinx-build.py
+++ b/Doc/tools/sphinx-build.py
@@ -11,14 +11,14 @@ import sys
if __name__ == '__main__':
- if sys.version_info[:3] < (2, 5, 1):
- print >>sys.stderr, """\
-Error: Sphinx needs to be executed with Python 2.5.1 or newer
-(If you run this from the Makefile, you can set the PYTHON variable
-to the path of an alternative interpreter executable, e.g.,
-``make html PYTHON=python2.5``).
-"""
- sys.exit(1)
+# if sys.version_info[:3] < (2, 5, 1):
+# print >>sys.stderr, """\
+#Error: Sphinx needs to be executed with Python 2.5.1 or newer
+#(If you run this from the Makefile, you can set the PYTHON variable
+#to the path of an alternative interpreter executable, e.g.,
+#``make html PYTHON=python2.5``).
+#"""
+# sys.exit(1)
from sphinx import main
sys.exit(main(sys.argv))
diff --git a/Doc/tools/sphinxext/download.html b/Doc/tools/sphinxext/download.html
new file mode 100644
index 0000000..f6a593a
--- /dev/null
+++ b/Doc/tools/sphinxext/download.html
@@ -0,0 +1,53 @@
+{% extends "layout.html" %}
+{% set title = 'Download' %}
+{% block body %}
+
+<h1>Download Python {{ release }} Documentation
+ {%- if last_updated %} (last updated on {{ last_updated }}){% endif %}</h1>
+
+<p>To download an archive containing all the documents for this version of
+Python in one of various formats, follow one of links in this table. The numbers
+in the table are the size of the download files in Kilobytes.</p>
+
+{# XXX download links #}
+
+
+<p>These archives contain all the content in the documentation section.</p>
+
+<h2>Unpacking</h2>
+
+<p>Unix users should download the .tar.bz2 archives; these are bzipped tar
+archives and can be handled in the usual way using tar and the bzip2
+program. The <a href="http://www.info-zip.org">InfoZIP</a> unzip program can be
+used to handle the ZIP archives if desired. The .tar.bz2 archives provide the
+best compression and fastest download times.</p>
+
+<p>Windows users can use the ZIP archives since those are customary on that
+platform. These are created on Unix using the InfoZIP zip program. They may be
+unpacked using the free WiZ tool (from the InfoZIP developers) or any other
+tool for handling ZIP archives; any of them should work.</p>
+
+<p>Note that the .tar.bz2 files are smaller than the other archives; Windows
+users may want to install the bzip2 tools on their systems as well. Windows
+binaries for a command-line tool are available at <a
+href="http://www.bzip.org">The bzip2 and libbzip2 official home page</a>, but
+most other archiving utilities support the tar and bzip2 formats as well.</p>
+
+
+<h2>Problems</h2>
+
+<p><strong>Printing PDFs using Adobe Acrobat Reader 5.0:</strong> Adobe has
+reportedly admitted that there is a bug in Acrobat Reader 5.0 which causes it
+not to print at least some PDF files generated by pdfTeX. This software is used
+to produce the PDF version of the Python documentation, and our documents
+definately trigger this bug in Acrobat Reader. To print the PDF files, use
+Acrobat Reader 4.x, ghostscript, or xpdf.</p>
+
+<p>Reportedly, Acrobat Reader 6.0 can print these documents without this
+problem, but we've not yet had an opportunity to confirm the report. Sadly,
+version 6.0 is not yet available on Unix platforms.</p>
+
+<p>If you have comments or suggestions for the Python documentation, please send
+email to <a href="docs@python.org">docs@python.org</a>.</p>
+
+{% endblock %}
diff --git a/Doc/tools/sphinxext/indexcontent.html b/Doc/tools/sphinxext/indexcontent.html
new file mode 100644
index 0000000..218f346
--- /dev/null
+++ b/Doc/tools/sphinxext/indexcontent.html
@@ -0,0 +1,56 @@
+ <p><strong>Parts of the documentation:</strong></p>
+ <table class="contentstable" align="center"><tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("whatsnew/" + version) }}">What's new in Python {{ version }}?</a><br>
+ <span class="linkdescr">changes since previous major release</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("tutorial/index") }}">Tutorial</a><br>
+ <span class="linkdescr">start here</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("using/index") }}">Using Python</a><br>
+ <span class="linkdescr">how to use Python on different platforms</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("reference/index") }}">Language Reference</a><br>
+ <span class="linkdescr">describes syntax and language elements</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br>
+ <span class="linkdescr">keep this under your pillow</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("howto/index") }}">Python HOWTOs</a><br>
+ <span class="linkdescr">in-depth documents on specific topics</span></p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("extending/index") }}">Extending and Embedding</a><br>
+ <span class="linkdescr">tutorial for C/C++ programmers</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("c-api/index") }}">Python/C API</a><br>
+ <span class="linkdescr">reference for C/C++ programmers</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("install/index") }}">Installing Python Modules</a><br>
+ <span class="linkdescr">information for installers &amp; sys-admins</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("distutils/index") }}">Distributing Python Modules</a><br>
+ <span class="linkdescr">sharing modules with others</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("documenting/index") }}">Documenting Python</a><br>
+ <span class="linkdescr">guide for documentation authors</span></p>
+ </td></tr>
+ </table>
+
+ <p><strong>Indices and tables:</strong></p>
+ <table class="contentstable" align="center"><tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("modindex") }}">Global Module Index</a><br>
+ <span class="linkdescr">quick access to all modules</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br>
+ <span class="linkdescr">all functions, classes, terms</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("glossary") }}">Glossary</a><br>
+ <span class="linkdescr">the most important terms explained</span></p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br>
+ <span class="linkdescr">search this documentation</span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Complete Table of Contents</a><br>
+ <span class="linkdescr">lists all sections and subsections</span></p>
+ </td></tr>
+ </table>
+
+ <p><strong>Meta information:</strong></p>
+ <table class="contentstable" align="center"><tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("bugs") }}">Reporting bugs</a></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("about") }}">About the documentation</a></p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("license") }}">History and License of Python</a></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("copyright") }}">Copyright</a></p>
+ </td></tr>
+ </table>
diff --git a/Doc/tools/sphinxext/indexsidebar.html b/Doc/tools/sphinxext/indexsidebar.html
new file mode 100644
index 0000000..b74c54f
--- /dev/null
+++ b/Doc/tools/sphinxext/indexsidebar.html
@@ -0,0 +1,19 @@
+ <h3>Download</h3>
+ <p><a href="{{ pathto('download') }}">Download these documents</a></p>
+ <h3>Other resources</h3>
+ <ul>
+ {# XXX: many of these should probably be merged in the main docs #}
+ <li><a href="http://www.python.org/doc/faq/">FAQs</a></li>
+ <li><a href="http://www.python.org/doc/intros/">Introductions</a></li>
+ <li><a href="http://www.python.org/doc/essays/">Guido's Essays</a></li>
+ <li><a href="http://www.python.org/doc/newstyle/">New-style Classes</a></li>
+ <li><a href="http://www.python.org/dev/peps/">PEP Index</a></li>
+ <li><a href="http://wiki.python.org/moin/BeginnersGuide">Beginner's Guide</a></li>
+ <li><a href="http://www.python.org/topics/">Topic Guides</a></li>
+ <li><a href="http://wiki.python.org/moin/PythonBooks">Book List</a></li>
+ <li><a href="http://www.python.org/doc/av/">Audio/Visual Talks</a></li>
+ <li><a href="http://www.python.org/doc/other/">Other Doc Collections</a></li>
+ <li>&nbsp;</li>
+ <li><a href="http://www.python.org/doc/versions/">Previous versions</a></li>
+ <li>&nbsp;</li>
+ </ul>