diff options
Diffstat (limited to 'docs/conventions.rst')
| -rw-r--r-- | docs/conventions.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst index 0bfe5e21e..020ed6dac 100644 --- a/docs/conventions.rst +++ b/docs/conventions.rst @@ -68,6 +68,13 @@ printed line should actually be part of the command: c:\bigfntut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \ --cover-erase --with-coverage +A sidebar, which presents a concept tangentially related to content +discussed on a page, is rendered like so: + +.. sidebar:: This is a sidebar + + Sidebar information. + In printed versions of this book, Python modules classes, methods, functions, and attributes that are part of the :mod:`repoze.bfg` module are referenced in paragraph text. These are contracted to omit @@ -83,3 +90,4 @@ Instead a contracted version will be rendered: .. code-block:: text configuration.Configurator.add_view (pp. XXX) + |