openstack
/
openstack-doc-tools
Code Issues Proposed changes

Handle User Guides 

Handle guides that have no content subdirectory for creation of the
preview index.html file. Examples are the User Guides.

Change-Id: I4c647ee997a4776011db2677d2a84237989f0a06
This commit is contained in:
Andreas Jaeger 2015-04-03 21:27:47 +02:00
parent 1b5f0b0360
commit 3f4165265a
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RELEASE_NOTES.rst
View File

@ -6,6 +6,8 @@ Release notes
* Added ``doc-tools-update-cli-reference``, a wrapper script to update
CLI references in the ``openstack-manuals`` repository.
* Handle guides that published without a content/ sub directory.
* Various fixes for auto generating commands and options.
0.23
----

5
os_doc_tools/doctest.py
View File

@ -1250,6 +1250,11 @@ def generate_index_file():
index_file.write('<a href="%s/content/index.html">%s</a>\n' %
(path, path))
index_file.write('<br/>\n')
elif os.path.isfile(os.path.join(root, 'index.html')):
path = os.path.relpath(root, publish_path)
index_file.write('<a href="%s/index.html">%s</a>\n' %
(path, path))
index_file.write('<br/>\n')
if os.path.isfile(os.path.join(root, 'api-ref.html')):
path = os.path.relpath(root, publish_path)