diff options
| author | Chris McDonough <chrism@agendaless.com> | 2009-12-30 17:21:27 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2009-12-30 17:21:27 +0000 |
| commit | 793425accac28fd0bea3e406404b9b351556fddb (patch) | |
| tree | 1dac70abbc9dea24b2b97d9bad0f7aa5b1f9c2a3 /docs/conventions.rst | |
| parent | 5d83d181a110c3a8dbb293711e99ae6ba13f0d3f (diff) | |
| download | pyramid-793425accac28fd0bea3e406404b9b351556fddb.tar.gz pyramid-793425accac28fd0bea3e406404b9b351556fddb.tar.bz2 pyramid-793425accac28fd0bea3e406404b9b351556fddb.zip | |
Better note/warning distinctions.
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) + |