docs: A set of cosmetical changes in documentation
- limit page width to 1100px and adjust frontpage tiles
- make glossary flat structure (remove sub sections)
- add favicon
- disable "View page source" link
- disable Prev,Next buttons
- disable "Built with Sphinx ..." in page footer
- add captions to some pages to shrink names in TOC
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: Ib6844b118c25b4437d7f11014112533fd8d5547b
diff --git a/docs/conf.py b/docs/conf.py
index f856fa7..796fa83 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -106,7 +106,15 @@
# further. For a list of options available for each theme, see the
# documentation.
#
-html_theme_options = {'collapse_navigation': False}
+html_theme_options = {
+ 'collapse_navigation': False,
+ 'prev_next_buttons_location' : None # Hide Prev and Next buttons
+# 'display_version': True, # Show version under logo
+}
+
+# Remove the "View page source" link from the top of docs pages
+html_show_sourcelink = False
+
#
# Add any paths that contain custom static files (such as style sheets) here,
# relative to configuration directory. They are copied after the builtin static
@@ -116,6 +124,9 @@
# Set the documentation logo relative to configuration directory
html_logo = '_static/images/tf_logo_white.png'
+# Set the documentation favicon
+html_favicon = '_static/images/favicon.ico'
+
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
@@ -129,6 +140,10 @@
#Disable adding conf.py copyright notice to HTML output
html_show_copyright = False
+# Disable showing Sphinx footer message:
+# "Built with Sphinx using a theme provided by Read the Docs. "
+html_show_sphinx = False
+
#Add custom css for HTML. Used to allow full page width rendering
def setup(app):
app.add_css_file('css/tfm_custom.css')