From 0be8d266fad466403fd0b418ae24888387fdfb69 Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Thu, 12 Dec 2019 02:15:49 +0100 Subject: [PATCH] Updates to sphinx files to improve HTML layout; added OSM SVG logo Signed-off-by: garciadeblas --- _static/style.css | 3 +++ _templates/layout.html | 4 +++ assets/osm_logo.svg | 59 ++++++++++++++++++++++++++++++++++++++++++ conf.py | 22 ++++++++++++++++ index.rst | 30 ++++++++++----------- 5 files changed, 102 insertions(+), 16 deletions(-) create mode 100644 _static/style.css create mode 100644 _templates/layout.html create mode 100644 assets/osm_logo.svg diff --git a/_static/style.css b/_static/style.css new file mode 100644 index 0000000..8aa6c28 --- /dev/null +++ b/_static/style.css @@ -0,0 +1,3 @@ +.wy-nav-content { + max-width: 1200px !important; +} diff --git a/_templates/layout.html b/_templates/layout.html new file mode 100644 index 0000000..3e44f4a --- /dev/null +++ b/_templates/layout.html @@ -0,0 +1,4 @@ +{% extends "!layout.html" %} +{% block extrahead %} + +{% endblock %} diff --git a/assets/osm_logo.svg b/assets/osm_logo.svg new file mode 100644 index 0000000..ebe15ef --- /dev/null +++ b/assets/osm_logo.svg @@ -0,0 +1,59 @@ + + + + + MANO-Color + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/conf.py b/conf.py index 53879d2..8b903e4 100644 --- a/conf.py +++ b/conf.py @@ -66,8 +66,30 @@ exclude_patterns = ['_build', 'TO-BE-MOVED-TO-OTHER-REPOS', 'Thumbs.db', '.DS_St #html_theme = 'pyramid' #html_theme = 'bizstyle' html_theme = 'sphinx_rtd_theme' +#html_theme = 'neo_rtd_theme' +#import sphinx_theme +#html_theme_path = [sphinx_theme.get_html_theme_path()] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + +html_theme_options = { + 'canonical_url': 'https://osm.etsi.org/docs', + 'logo_only': True, + 'display_version': True, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': False, + #'style_nav_header_background': 'white', + # Toc options + 'collapse_navigation': True, + 'sticky_navigation': True, + 'navigation_depth': 3, + 'includehidden': True, + 'titles_only': False +} + +#html_logo = 'assets/osm_logo.png' +html_logo = 'assets/osm_logo.svg' + diff --git a/index.rst b/index.rst index 545517a..c71c3cf 100644 --- a/index.rst +++ b/index.rst @@ -7,24 +7,22 @@ Welcome to Open Source MANO's documentation! ============================================ .. toctree:: - :numbered: :maxdepth: 2 :caption: Table of Contents :name: mastertoc - :titlesonly: - 01-quickstart.md - 02-osm-architecture-and-functions.md - 03-installing-osm.md - 04-vim-setup.md - 05-osm-usage.md - 06-osm-platform-configuration.md - 07-what-to-read-next.md - 08-how-to-contribute-to-docs.md - 09-troubleshooting.md - 10-osm-client-commands-reference.md - 11-osm-im.md - 12-osm-nbi.md - 13-openvim-installation.md - 14-tests-for-vim-validation.md + 01-quickstart + 02-osm-architecture-and-functions + 03-installing-osm + 04-vim-setup + 05-osm-usage + 06-osm-platform-configuration + 07-what-to-read-next + 08-how-to-contribute-to-docs + 09-troubleshooting + 10-osm-client-commands-reference + 11-osm-im + 12-osm-nbi + 13-openvim-installation + 14-tests-for-vim-validation -- GitLab