summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBeth Elwell <belwell@redhat.com>2017-02-22 09:40:18 -0500
committerBeth Elwell <belwell@redhat.com>2017-02-22 09:47:38 -0500
commitb29dc2937e004a4f29ba21514fe9bfe844e0ae9a (patch)
tree21ce0bf430945261315031712b1bb982429ec956
parent2f8d5756fb9c5ba7dc0d68e4a5c9ed5d332b4e69 (diff)
downloadoslosphinx-b29dc2937e004a4f29ba21514fe9bfe844e0ae9a.tar.gz
Amended dev documentation side navigation
Amended developer documentation side navigation to add an option for clearly returning to the project developer documentation home page. Previously it was possible to return to the home page by clicking 'table of contents' however this is not obvious and makes it hard to get around the complete project documentation once you have left the homepage. This patch removes the link from 'table of contents' which is misleading, and a link is added beneath this header to say 'Return to project home page'. Change-Id: I7cf96acead62f00224ca9217a80760b4a65d42d6 Closes-bug: #1666323
-rw-r--r--oslosphinx/theme/openstack/layout.html3
1 files changed, 2 insertions, 1 deletions
diff --git a/oslosphinx/theme/openstack/layout.html b/oslosphinx/theme/openstack/layout.html
index c3878eb..655febd 100644
--- a/oslosphinx/theme/openstack/layout.html
+++ b/oslosphinx/theme/openstack/layout.html
@@ -14,7 +14,8 @@
{%- endblock %}
{%- block sidebartoc %}
{%- if display_toc %}
- <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
+ <h3>{{ _('Table Of Contents') }}</h3>
+ <ul><li><a href="{{ pathto(master_doc) }}">Return to project home page</a></li></ul>
{{ toc }}
{%- endif %}
{%- endblock %}