IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix #3488: objects.inv has broken when `release or version` contain return code

Browse Source
This commit is contained in:
Takeshi KOMIYA 2017-03-02 13:32:46 +09:00
parent cdacabdab3
commit 3a3cec7a8e
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -19,6 +19,8 @@ Bugs fixed
to failed PDF build to failed PDF build
* EPUB file has duplicated ``nav.xhtml`` link in ``content.opf`` * EPUB file has duplicated ``nav.xhtml`` link in ``content.opf``
except first time build except first time build
* #3488: objects.inv has broken when ``release`` or ``version`` contain
return code
Testing Testing
-------- --------

6
sphinx/builders/html.py
View File

@ -849,13 +849,17 @@ class StandaloneHTMLBuilder(Builder):
self.finish_tasks.add_task(self.dump_inventory) self.finish_tasks.add_task(self.dump_inventory)
def dump_inventory(self): def dump_inventory(self):
def safe_name(string):
return re.sub("\s+", " ", string)
self.info(bold('dumping object inventory... '), nonl=True) self.info(bold('dumping object inventory... '), nonl=True)
with open(path.join(self.outdir, INVENTORY_FILENAME), 'wb') as f: with open(path.join(self.outdir, INVENTORY_FILENAME), 'wb') as f:
f.write((u'# Sphinx inventory version 2\n' f.write((u'# Sphinx inventory version 2\n'
u'# Project: %s\n' u'# Project: %s\n'
u'# Version: %s\n' u'# Version: %s\n'
u'# The remainder of this file is compressed using zlib.\n' u'# The remainder of this file is compressed using zlib.\n'
% (self.config.project, self.config.version)).encode('utf-8')) % (safe_name(self.config.project),
safe_name(self.config.version))).encode('utf-8'))
compressor = zlib.compressobj(9) compressor = zlib.compressobj(9)
for domainname, domain in sorted(self.env.domains.items()): for domainname, domain in sorted(self.env.domains.items()):
for name, dispname, type, docname, anchor, prio in \ for name, dispname, type, docname, anchor, prio in \