Chris McDonough
2009-12-30 793425accac28fd0bea3e406404b9b351556fddb
Better note/warning distinctions.

3 files modified
49 ■■■■■ changed files
docs/conf.py 33 ●●●●● patch | view | raw | blame | history
docs/conventions.rst 8 ●●●●● patch | view | raw | blame | history
docs/narr/project.rst 8 ●●●● patch | view | raw | blame | history
docs/conf.py
@@ -242,6 +242,39 @@
}
\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
"""
docs/conventions.rst
@@ -68,6 +68,13 @@
     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 @@
  .. code-block:: text
     configuration.Configurator.add_view (pp. XXX)
docs/narr/project.rst
@@ -259,6 +259,10 @@
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`
@@ -268,10 +272,6 @@
   usually easier to develop an application using the ``paster serve``
   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: