openstack/openstack-doc-tools
Code Issues Proposed changes

Always build index for checkbuild

Browse Source 
Always build the index files during checkbuild. With RST guides, the
index was not build everytime.

Also, update the Release Notes.

Change-Id: I2b7f2e02e81de8255307d5a0b1b3f10f73c13273
This commit is contained in:
Andreas Jaeger 2015-06-26 10:45:02 +02:00
parent d8165184d1
commit 5e9b716092
2 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
RELEASE_NOTES.rst
View File

@ -1,6 +1,12 @@
Release notes
=============
0.30.0
------
* ``openstack-doc-test``: Always built index page in checkbuild.
* ``openstack-auto-commands``: Add support for murano.
0.29.1
------

36
os_doc_tools/doctest.py
View File

@ -1571,6 +1571,26 @@ def handle_options():
print(" Comments enabled: %s" % cfg.CONF.comments_enabled)
def check_no_building():
"""Figure out whether we need to build XML files."""
CONF = cfg.CONF
if not CONF.force and www_touched():
print("Only files in www directory changed, nothing to do.\n")
return True
# Build everything if we publish so that regularly all manuals are
# published, for testing ignore the locale directories.
if (not CONF.force and not CONF.publish and not CONF.language
and only_po_touched()):
print("Only files in locale directories changed, nothing to do.\n")
return True
# If only RST files are touched, there's nothing to do.
if (not CONF.force and only_rst_touched()):
print("Only RST files changed, nothing to do.\n")
return True
return False
def doctest():
"""Central entrypoint, parses arguments and runs tests."""
@ -1594,20 +1614,8 @@ def doctest():
elif not CONF.api_site:
doc_path = os.path.join(doc_path, 'doc')
if not CONF.force and www_touched():
print("Only files in www directory changed, nothing to do.\n")
return
# Build everything if we publish so that regularly all manuals are
# published, for testing ignore the locale directories.
if (not CONF.force and not CONF.publish and not CONF.language
and only_po_touched()):
print("Only files in locale directories changed, nothing to do.\n")
return
# If only RST files are touched, there's nothing to do.
if (not CONF.force and only_rst_touched()):
print("Only RST files changed, nothing to do.\n")
if cfg.CONF.create_index:
if check_no_building():
if CONF.create_index:
generate_index_file()
return