openstack/oslosphinx
Code Issues Proposed changes

Amended dev documentation side navigation

Browse Source 
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
This commit is contained in:
Beth Elwell 2017-02-22 09:40:18 -05:00
parent 2f8d5756fb
commit b29dc2937e
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
oslosphinx/theme/openstack/layout.html
View File

@ -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 %}