Documentation: support versioned docs

This commit is contained in:
Matias N 2020-11-26 15:15:49 -03:00 committed by Brennan Ashton
parent 36088e8d21
commit a59c7744f8
4 changed files with 13 additions and 6 deletions

View File

@ -23,7 +23,7 @@
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -j auto
SPHINXOPTS ?= -j auto -A nuttx_versions="latest,${NUTTX_VERSIONS}"
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

View File

@ -86,3 +86,8 @@ span.menuselection
border-radius: 3px;
border: 1px solid rgb(204, 204, 204);
}
div.version-selector
{
margin-bottom: 1em;
}

View File

@ -37,9 +37,9 @@
more modern -->
<div class="version-selector">
<select>
{% for nuttx_version in nuttx_versions %}
<option value="{{ nuttx_version }}" {% if nuttx_version == version %}selected="selected"{% endif %}>{{ nuttx_version }}</option>
<select onchange="javascript:location.href = this.value;">
{% for nuttx_version in nuttx_versions.split(',') %}
<option value="{{ url_root }}../{{ nuttx_version }}" {% if nuttx_version == version %}selected="selected"{% endif %}>{{ nuttx_version }}</option>
{% endfor %}
</select>
</div>

View File

@ -74,10 +74,12 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# list of documentation versions to offer (besides latest)
# list of documentation versions to offer (besides latest). this will be
# overriden by command line option but we can provide a sane default
# this way
html_context = dict()
html_context['nuttx_versions'] = ['latest']
html_context['nuttx_versions'] = 'latest'
# TODO: append other options using releases detected from git (or maybe just
# a few hand-selected ones, or maybe just a "stable" option)