doc: add support for publishing versioned docs

add navigation to (manually) maintained list (in conf.py) of versioned
docs, and update generating and publishing processes to be
version-aware.

Adds a file to redirect root references to /latest folder now (since we
can't update the server redirects).  Might break some links to pages
within the site from external sites.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder
2018-04-13 14:36:25 -07:00
committed by Jack Ren
parent 6b1782b360
commit b997e590f2
5 changed files with 87 additions and 9 deletions

View File

@@ -87,6 +87,9 @@ finally:
else:
sys.stderr.write('Warning: Could not extract hypervisor version from Makefile\n')
version = release = "unknown"
#
# The short X.Y version.
# version = u'0.1'
@@ -141,8 +144,26 @@ else:
# Toc options
'collapse_navigation': False,
'sticky_navigation': True,
'navigation_depth': 4
}
'navigation_depth': 4,
}
# Here's where we (manually) list the document versions maintained on
# the published doc website. On a daily basis we publish to the
# /latest folder but when releases are made, we publish to a /<relnum>
# folder (specified via RELEASE=name on the make command).
if tags.has('release'):
current_version = version
else:
version = current_version = "latest"
html_context = {
'current_version': current_version,
'versions': ( ("latest", "/latest/"),
("0.1-rc4", "/0.1-rc4/"),
)
}
# Theme options are theme-specific and customize the look and feel of a theme
@@ -258,3 +279,4 @@ breathe_projects = {
"Project ACRN" : "doxygen/xml",
}
breathe_default_project = "Project ACRN"
breathe_default_members = ('members', 'undoc-members', 'content-only')