Commit 9d8593ec authored by garciadeblas's avatar garciadeblas
Browse files

Support of multiple versions in OSM user guide

parent abd6db4b

Makefile

+4 −0
Original line number Diff line number Diff line
@@ -16,5 +16,9 @@ help: 


# Catch-all target: route all unknown targets to Sphinx using the new

# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

html: Makefile

	sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)/html"

	./fix_cross_references.sh



%: Makefile

	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

_templates/versions.html

0 → 100644
+24 −0
Original line number Diff line number Diff line 
{%- if current_version %}

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">

  <span class="rst-current-version" data-toggle="rst-current-version">

    <span class="fa fa-book"> Other Versions</span>

    v: {{ current_version.name }}

    <span class="fa fa-caret-down"></span>

  </span>

  <div class="rst-other-versions">

    <dl>

      <dt>Versions</dt>

      {%- if versions.tags %}

      {%- for item in versions.tags %}

      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>

      {%- endfor %}

      {%- endif %}

      {%- if versions.branches %}

      {%- for item in versions.branches|sort(attribute="name",reverse=True) %}

      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>

      {%- endfor %}

      {%- endif %}

    </dl>

  </div>

</div>

{%- endif %}

conf.py

+14 −0
Original line number Diff line number Diff line
@@ -37,6 +37,7 @@ extensions = ['sphinx.ext.autodoc', 
    'sphinx.ext.githubpages',

    'recommonmark',

    'sphinx_markdown_tables',

    'sphinx_multiversion',

]



source_suffix = {
@@ -94,3 +95,16 @@ html_theme_options = { 
#html_logo = 'assets/osm_logo.png'

html_logo = 'assets/osm_logo.svg'



smv_current_version = 'latest'

#smv_tag_whitelist = None

#smv_tag_whitelist = r'^v\d+\.\d+$'

smv_tag_whitelist = 'latest'

#smv_branch_whitelist = None

#smv_branch_whitelist = r'^v\d+\.\d+$'

smv_branch_whitelist = r'(v11|v10)'

#smv_remote_whitelist = 'None'

smv_remote_whitelist = r'(origin)'

smv_released_pattern = r'(latest|v11|v10)'

#smv_outputdir_format = 'versions/{config.release}'    # Use "versions" as parent directory and the "release" variable from conf.py

#smv_outputdir_format = 'versions/{ref.name}'

index.md

+4 −3
Original line number Diff line number Diff line
@@ -23,6 +23,7 @@ 
11. [ANNEX 3: Reference of OSM's Information Model](11-osm-im.md)

12. [ANNEX 4: Reference of OSM's Northbound Interface](12-osm-nbi.md)

13. [ANNEX 5: OpenVIM installation](13-openvim-installation.md)

14. [ANNEX 6: Tests to validate VIM capabilities from OSM](14-tests-for-vim-validation.md)

15. [ANNEX 7: Kubernetes installation and requirements](15-k8s-installation.md)

16. [ANNEX 8: Setting up an LXD Cluster](16-lxd-cluster.md)
 
15. [ANNEX 6: Kubernetes installation and requirements](15-k8s-installation.md)

16. [ANNEX 7: Setting up an LXD Cluster](16-lxd-cluster.md)

17. [ANNEX 8: TACACS Based Authentication Support In OSM](18-tacacs-based-authentication.md)