Commit c1725747 authored by Georg Brandl's avatar Georg Brandl

Merged revisions 71960 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r71960 | georg.brandl | 2009-04-26 11:56:44 +0200 (So, 26 Apr 2009) | 1 line

  Move pydoc_topics module to its own subdirectory, so that no generated code is in Lib/.
........
parent 7e870c58
......@@ -28,6 +28,7 @@ help:
@echo " coverage to check documentation coverage for library and C API"
@echo " dist to create a \"dist\" directory with archived docs for download"
# Note: if you update versions here, do the same in make.bat and README.txt
checkout:
@if [ ! -d tools/sphinx ]; then \
echo "Checking out Sphinx..."; \
......@@ -101,8 +102,8 @@ doctest: build
pydoc-topics: BUILDER = pydoc-topics
pydoc-topics: build
@echo "Building finished; now copy build/pydoc-topics/pydoc_topics.py " \
"into the Lib/ directory"
@echo "Building finished; now copy build/pydoc-topics/topics.py " \
"to Lib/pydoc_data/topics.py"
htmlview: html
$(PYTHON) -c "import webbrowser; webbrowser.open('build/html/index.html')"
......
......@@ -5,7 +5,7 @@
Sphinx extension with Python doc-specific markup.
:copyright: 2008 by Georg Brandl.
:copyright: 2008, 2009 by Georg Brandl.
:license: Python license.
"""
......@@ -87,7 +87,7 @@ class PydocTopicsBuilder(Builder):
self.topics[label] = str(writer.output)
def finish(self):
f = open(path.join(self.outdir, 'pydoc_topics.py'), 'w')
f = open(path.join(self.outdir, 'topics.py'), 'w')
try:
f.write('# Autogenerated by Sphinx on %s\n' % asctime())
f.write('topics = ' + pformat(self.topics) + '\n')
......
......@@ -1530,11 +1530,11 @@ class Helper:
# These dictionaries map a topic name to either an alias, or a tuple
# (label, seealso-items). The "label" is the label of the corresponding
# section in the .rst file under Doc/ and an index into the dictionary
# in pydoc_topics.py.
# in pydoc_data/topics.py.
#
# CAUTION: if you change one of these dictionaries, be sure to adapt the
# list of needed labels in Doc/tools/sphinxext/pyspecific.py and
# regenerate the pydoc_topics.py file by running
# regenerate the pydoc_data/topics.py file by running
# make pydoc-topics
# in Doc/ and copying the output file into the Lib/ directory.
......@@ -1809,11 +1809,11 @@ Here is a list of available topics. Enter any topic name to get more help.
def showtopic(self, topic, more_xrefs=''):
try:
import pydoc_topics
import pydoc_data.topics
except ImportError:
self.output.write('''
Sorry, topic and keyword documentation is not available because the
module "pydoc_topics" could not be found.
module "pydoc_data.topics" could not be found.
''')
return
target = self.topics.get(topic, self.keywords.get(topic))
......@@ -1825,7 +1825,7 @@ module "pydoc_topics" could not be found.
label, xrefs = target
try:
doc = pydoc_topics.topics[label]
doc = pydoc_data.topics.topics[label]
except KeyError:
self.output.write('no documentation found for %s\n' % repr(topic))
return
......
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment