IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove outdated info and add an XXX.

Browse Source
This commit is contained in:
Georg Brandl
2008-03-23 14:33:11 +00:00
parent 9d32eb44d1
commit 5fb481715c
1 changed files with 1 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
doc/templating.rst
View File

@@ -18,45 +18,4 @@ Inheritance is done via two directives, ``extends`` and ``block``.
blocks
extends !template
These are the blocks that are predefined in Sphinx' ``layout.html`` template:
**doctype**
The doctype, by default HTML 4 Transitional.
**rellinks**
HTML ``<link rel=`` links in the head, by default filled with various links.
**extrahead**
Block in the ``<head>`` tag, by default empty.
**beforerelbar**
Block before the "related bar" (the navigation links at the page top), by
default empty. Use this to insert a page header.
**relbar**
The "related bar" by default. Overwrite this block to customize the entire
navigation bar.
**rootrellink**
The most parent relbar link, by default pointing to the "index" document with
a caption of e.g. "Project v0.1 documentation".
**relbaritems**
Block in the ``<ul>`` used for relbar items, by default empty. Use this to
add more items.
**afterrelbar**
Block between relbar and document body, by default empty.
**body**
Block in the document body. This should be overwritten by every child
template, e.g. :file:`page.html` puts the page content there.
**beforesidebar**
Block between body and sidebar, by default empty.
**sidebar**
Contains the whole sidebar.
**aftersidebar**
Block between
XXX continue this