summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-12-30 17:21:27 +0000
committerChris McDonough <chrism@agendaless.com>2009-12-30 17:21:27 +0000
commit793425accac28fd0bea3e406404b9b351556fddb (patch)
tree1dac70abbc9dea24b2b97d9bad0f7aa5b1f9c2a3 /docs
parent5d83d181a110c3a8dbb293711e99ae6ba13f0d3f (diff)
downloadpyramid-793425accac28fd0bea3e406404b9b351556fddb.tar.gz
pyramid-793425accac28fd0bea3e406404b9b351556fddb.tar.bz2
pyramid-793425accac28fd0bea3e406404b9b351556fddb.zip
Better note/warning distinctions.
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py33
-rw-r--r--docs/conventions.rst8
-rw-r--r--docs/narr/project.rst8
3 files changed, 45 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 98452669f..58b985869 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -242,6 +242,39 @@ _PREAMBLE = r"""
}
\makeatother
+% Redefine these colors to your liking in the preamble.
+\definecolor{TitleColor}{rgb}{0,0,0}
+\definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486}
+\definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388}
+% Redefine these colors to something not white if you want to have colored
+% background and border for code examples.
+\definecolor{VerbatimColor}{rgb}{1,1,1}
+\definecolor{VerbatimBorderColor}{rgb}{1,1,1}
+
+\makeatletter
+% Notices / Admonitions
+%
+\newcommand{\py@veryheavybox}{
+ \setlength{\fboxrule}{2pt}
+ \setlength{\fboxsep}{7pt}
+ \setlength{\py@noticelength}{\linewidth}
+ \addtolength{\py@noticelength}{-2\fboxsep}
+ \addtolength{\py@noticelength}{-2\fboxrule}
+ \setlength{\shadowsize}{3pt}
+ \Sbox
+ \minipage{\py@noticelength}
+}
+\newcommand{\py@endveryheavybox}{
+ \endminipage
+ \endSbox
+ \fbox{\TheSbox}
+}
+\renewcommand{\py@noticestart@warning}{\py@veryheavybox}
+\renewcommand{\py@noticeend@warning}{\py@endveryheavybox}
+\renewcommand{\py@noticestart@note}{\py@heavybox}
+\renewcommand{\py@noticeend@note}{\py@endheavybox}
+\makeatother
+
\sloppy
"""
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)
+
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 1c1dde131..c76223401 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -259,6 +259,10 @@ Once the project is installed for development, you can run the
application it represents using the ``paster serve`` command against
the generated ``MyProject.ini`` configuration file:
+.. code-block:: text
+
+ $ ../bin/paster serve MyProject.ini
+
.. sidebar:: Using ``mod_wsgi``
You can also use :term:`mod_wsgi` to serve your :mod:`repoze.bfg`
@@ -269,10 +273,6 @@ the generated ``MyProject.ini`` configuration file:
webserver, as exception and debugging output will be sent to the
console.
-.. code-block:: text
-
- $ ../bin/paster serve MyProject.ini
-
Here's sample output from a run:
.. code-block:: text