[Python-checkins] r66583 - in doctools/trunk: CHANGES doc/templating.rst sphinx/templates/layout.html

georg.brandl python-checkins at python.org
Wed Sep 24 13:48:44 CEST 2008


Author: georg.brandl
Date: Wed Sep 24 13:48:43 2008
New Revision: 66583

Log:
Rename rellinks to linktags.


Modified:
   doctools/trunk/CHANGES
   doctools/trunk/doc/templating.rst
   doctools/trunk/sphinx/templates/layout.html

Modified: doctools/trunk/CHANGES
==============================================================================
--- doctools/trunk/CHANGES	(original)
+++ doctools/trunk/CHANGES	Wed Sep 24 13:48:43 2008
@@ -78,6 +78,9 @@
 * Added new events: ``env-updated``, ``missing-reference``,
   ``build-finished``.
 
+* The ``rellinks`` block in the layout template is now called
+  ``linktags`` to avoid confusion with the relbar links.
+
 
 Release 0.4.2 (Jul 29, 2008)
 ============================

Modified: doctools/trunk/doc/templating.rst
==============================================================================
--- doctools/trunk/doc/templating.rst	(original)
+++ doctools/trunk/doc/templating.rst	Wed Sep 24 13:48:43 2008
@@ -82,7 +82,7 @@
     idea not to change it unless you want to switch to HTML 5 or a different but
     compatible XHTML doctype.
 
-`rellinks`
+`linktags`
     This block adds a couple of ``<link>`` tags to the head section of the
     template.
 
@@ -102,11 +102,11 @@
 
 `rootrellink` / `relbaritems`
     Inside the relbar there are three sections: The `rootrellink`, the links
-    from the documentation and the `relbaritems`.  The `rootrellink` is a block
-    that by default contains a list item pointing to the master document by
-    default, the `relbaritems` is an empty block.  If you override them to add
-    extra links into the bar make sure that they are list items and end with the
-    :data:`reldelim1`.
+    from the documentation and the custom `relbaritems`.  The `rootrellink` is a
+    block that by default contains a list item pointing to the master document
+    by default, the `relbaritems` is an empty block.  If you override them to
+    add extra links into the bar make sure that they are list items and end with
+    the :data:`reldelim1`.
 
 `document`
     The contents of the document itself.

Modified: doctools/trunk/sphinx/templates/layout.html
==============================================================================
--- doctools/trunk/sphinx/templates/layout.html	(original)
+++ doctools/trunk/sphinx/templates/layout.html	Wed Sep 24 13:48:43 2008
@@ -15,7 +15,7 @@
           {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
         {%- endfor %}
         {%- block rootrellink %}
-        <li><a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
+        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
         {%- endblock %}
         {%- for parent in parents %}
           <li><a href="{{ parent.link|e }}" accesskey="U">{{ parent.title }}</a>{{ reldelim1 }}</li>
@@ -122,12 +122,11 @@
     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
     {%- endif %}
     {%- endif %}
-{%- block rellinks %}
+{%- block linktags %}
     {%- if hasdoc('about') %}
     <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
     {%- endif %}
-    <link rel="contents" title="{{ _('Global table of contents') }}" href="{{ pathto('contents') }}" />
-    <link rel="index" title="{{ _('Global index') }}" href="{{ pathto('genindex') }}" />
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
     <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
     {%- if hasdoc('copyright') %}
     <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />


More information about the Python-checkins mailing list