doc/api/python/epydoc.css
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 
       
     2 
       
     3 /* Epydoc CSS Stylesheet
       
     4  *
       
     5  * This stylesheet can be used to customize the appearance of epydoc's
       
     6  * HTML output.
       
     7  *
       
     8  */
       
     9 
       
    10 /* Default Colors & Styles
       
    11  *   - Set the default foreground & background color with 'body'; and 
       
    12  *     link colors with 'a:link' and 'a:visited'.
       
    13  *   - Use bold for decision list terms.
       
    14  *   - The heading styles defined here are used for headings *within*
       
    15  *     docstring descriptions.  All headings used by epydoc itself use
       
    16  *     either class='epydoc' or class='toc' (CSS styles for both
       
    17  *     defined below).
       
    18  */
       
    19 body                        { background: #ffffff; color: #000000; }
       
    20 a:link                      { color: #0000ff; }
       
    21 a:visited                   { color: #204080; }
       
    22 dt                          { font-weight: bold; }
       
    23 h1                          { font-size: +140%; font-style: italic;
       
    24                               font-weight: bold; }
       
    25 h2                          { font-size: +125%; font-style: italic;
       
    26                               font-weight: bold; }
       
    27 h3                          { font-size: +110%; font-style: italic;
       
    28                               font-weight: normal; }
       
    29 code                        { font-size: 100%; }
       
    30  
       
    31 /* Page Header & Footer
       
    32  *   - The standard page header consists of a navigation bar (with
       
    33  *     pointers to standard pages such as 'home' and 'trees'); a
       
    34  *     breadcrumbs list, which can be used to navigate to containing
       
    35  *     classes or modules; options links, to show/hide private
       
    36  *     variables and to show/hide frames; and a page title (using
       
    37  *     <h1>).  The page title may be followed by a link to the
       
    38  *     corresponding source code (using 'span.codelink').
       
    39  *   - The footer consists of a navigation bar, a timestamp, and a
       
    40  *     pointer to epydoc's homepage.
       
    41  */ 
       
    42 h1.epydoc                   { margin: 0; font-size: +140%; font-weight: bold; }
       
    43 h2.epydoc                   { font-size: +130%; font-weight: bold; }
       
    44 h3.epydoc                   { font-size: +115%; font-weight: bold; }
       
    45 td h3.epydoc                { font-size: +115%; font-weight: bold;
       
    46                               margin-bottom: 0; }
       
    47 table.navbar                { background: #a0c0ff; color: #000000;
       
    48                               border: 2px groove #c0d0d0; }
       
    49 table.navbar table          { color: #000000; }
       
    50 th.navbar-select            { background: #70b0ff;
       
    51                               color: #000000; } 
       
    52 table.navbar a              { text-decoration: none; }  
       
    53 table.navbar a:link         { color: #0000ff; }
       
    54 table.navbar a:visited      { color: #204080; }
       
    55 span.breadcrumbs            { font-size: 85%; font-weight: bold; }
       
    56 span.options                { font-size: 70%; }
       
    57 span.codelink               { font-size: 85%; }
       
    58 td.footer                   { font-size: 85%; }
       
    59 
       
    60 /* Table Headers
       
    61  *   - Each summary table and details section begins with a 'header'
       
    62  *     row.  This row contains a section title (marked by
       
    63  *     'span.table-header') as well as a show/hide private link
       
    64  *     (marked by 'span.options', defined above).
       
    65  *   - Summary tables that contain user-defined groups mark those
       
    66  *     groups using 'group header' rows.
       
    67  */
       
    68 td.table-header             { background: #70b0ff; color: #000000;
       
    69                               border: 1px solid #608090; }
       
    70 td.table-header table       { color: #000000; }
       
    71 td.table-header table a:link      { color: #0000ff; }
       
    72 td.table-header table a:visited   { color: #204080; }
       
    73 span.table-header           { font-size: 120%; font-weight: bold; }
       
    74 th.group-header             { background: #c0e0f8; color: #000000;
       
    75                               text-align: left; font-style: italic; 
       
    76                               font-size: 115%; 
       
    77                               border: 1px solid #608090; }
       
    78 
       
    79 /* Summary Tables (functions, variables, etc)
       
    80  *   - Each object is described by a single row of the table with
       
    81  *     two cells.  The left cell gives the object's type, and is
       
    82  *     marked with 'code.summary-type'.  The right cell gives the
       
    83  *     object's name and a summary description.
       
    84  *   - CSS styles for the table's header and group headers are
       
    85  *     defined above, under 'Table Headers'
       
    86  */
       
    87 table.summary               { border-collapse: collapse;
       
    88                               background: #e8f0f8; color: #000000;
       
    89                               border: 1px solid #608090;
       
    90                               margin-bottom: 0.5em; }
       
    91 td.summary                  { border: 1px solid #608090; }
       
    92 code.summary-type           { font-size: 85%; }
       
    93 table.summary a:link        { color: #0000ff; }
       
    94 table.summary a:visited     { color: #204080; }
       
    95 
       
    96 
       
    97 /* Details Tables (functions, variables, etc)
       
    98  *   - Each object is described in its own div.
       
    99  *   - A single-row summary table w/ table-header is used as
       
   100  *     a header for each details section (CSS style for table-header
       
   101  *     is defined above, under 'Table Headers').
       
   102  */
       
   103 table.details               { border-collapse: collapse;
       
   104                               background: #e8f0f8; color: #000000;
       
   105                               border: 1px solid #608090;
       
   106                               margin: .2em 0 0 0; }
       
   107 table.details table         { color: #000000; }
       
   108 table.details a:link        { color: #0000ff; }
       
   109 table.details a:visited     { color: #204080; }
       
   110 
       
   111 /* Fields */
       
   112 dl.fields                   { margin-left: 2em; margin-top: 1em;
       
   113                               margin-bottom: 1em; }
       
   114 dl.fields dd ul             { margin-left: 0em; padding-left: 0em; }
       
   115 div.fields                  { margin-left: 2em; }
       
   116 div.fields p                { margin-bottom: 0.5em; }
       
   117 
       
   118 /* Index tables (identifier index, term index, etc)
       
   119  *   - link-index is used for indices containing lists of links
       
   120  *     (namely, the identifier index & term index).
       
   121  *   - index-where is used in link indices for the text indicating
       
   122  *     the container/source for each link.
       
   123  *   - metadata-index is used for indices containing metadata
       
   124  *     extracted from fields (namely, the bug index & todo index).
       
   125  */
       
   126 table.link-index            { border-collapse: collapse;
       
   127                               background: #e8f0f8; color: #000000;
       
   128                               border: 1px solid #608090; }
       
   129 td.link-index               { border-width: 0px; }
       
   130 table.link-index a:link     { color: #0000ff; }
       
   131 table.link-index a:visited  { color: #204080; }
       
   132 span.index-where            { font-size: 70%; }
       
   133 table.metadata-index        { border-collapse: collapse;
       
   134                               background: #e8f0f8; color: #000000;
       
   135                               border: 1px solid #608090; 
       
   136                               margin: .2em 0 0 0; }
       
   137 td.metadata-index           { border-width: 1px; border-style: solid; }
       
   138 table.metadata-index a:link { color: #0000ff; }
       
   139 table.metadata-index a:visited  { color: #204080; }
       
   140 
       
   141 /* Function signatures
       
   142  *   - sig* is used for the signature in the details section.
       
   143  *   - .summary-sig* is used for the signature in the summary 
       
   144  *     table, and when listing property accessor functions.
       
   145  * */
       
   146 .sig-name                   { color: #006080; }
       
   147 .sig-arg                    { color: #008060; }
       
   148 .sig-default                { color: #602000; }
       
   149 .summary-sig                { font-family: monospace; }
       
   150 .summary-sig-name           { color: #006080; font-weight: bold; }
       
   151 table.summary a.summary-sig-name:link
       
   152                             { color: #006080; font-weight: bold; }
       
   153 table.summary a.summary-sig-name:visited
       
   154                             { color: #006080; font-weight: bold; }
       
   155 .summary-sig-arg            { color: #006040; }
       
   156 .summary-sig-default        { color: #501800; }
       
   157 
       
   158 /* To render variables, classes etc. like functions */
       
   159 table.summary .summary-name { color: #006080; font-weight: bold;
       
   160                               font-family: monospace; }
       
   161 table.summary
       
   162      a.summary-name:link    { color: #006080; font-weight: bold;
       
   163                               font-family: monospace; }
       
   164 table.summary
       
   165     a.summary-name:visited  { color: #006080; font-weight: bold;
       
   166                               font-family: monospace; }
       
   167 
       
   168 /* Variable values
       
   169  *   - In the 'variable details' sections, each varaible's value is
       
   170  *     listed in a 'pre.variable' box.  The width of this box is
       
   171  *     restricted to 80 chars; if the value's repr is longer than
       
   172  *     this it will be wrapped, using a backslash marked with
       
   173  *     class 'variable-linewrap'.  If the value's repr is longer
       
   174  *     than 3 lines, the rest will be ellided; and an ellipsis
       
   175  *     marker ('...' marked with 'variable-ellipsis') will be used.
       
   176  *   - If the value is a string, its quote marks will be marked
       
   177  *     with 'variable-quote'.
       
   178  *   - If the variable is a regexp, it is syntax-highlighted using
       
   179  *     the re* CSS classes.
       
   180  */
       
   181 pre.variable                { padding: .5em; margin: 0;
       
   182                               background: #dce4ec; color: #000000;
       
   183                               border: 1px solid #708890; }
       
   184 .variable-linewrap          { color: #604000; font-weight: bold; }
       
   185 .variable-ellipsis          { color: #604000; font-weight: bold; }
       
   186 .variable-quote             { color: #604000; font-weight: bold; }
       
   187 .variable-group             { color: #008000; font-weight: bold; }
       
   188 .variable-op                { color: #604000; font-weight: bold; }
       
   189 .variable-string            { color: #006030; }
       
   190 .variable-unknown           { color: #a00000; font-weight: bold; }
       
   191 .re                         { color: #000000; }
       
   192 .re-char                    { color: #006030; }
       
   193 .re-op                      { color: #600000; }
       
   194 .re-group                   { color: #003060; }
       
   195 .re-ref                     { color: #404040; }
       
   196 
       
   197 /* Base tree
       
   198  *   - Used by class pages to display the base class hierarchy.
       
   199  */
       
   200 pre.base-tree               { font-size: 80%; margin: 0; }
       
   201 
       
   202 /* Frames-based table of contents headers
       
   203  *   - Consists of two frames: one for selecting modules; and
       
   204  *     the other listing the contents of the selected module.
       
   205  *   - h1.toc is used for each frame's heading
       
   206  *   - h2.toc is used for subheadings within each frame.
       
   207  */
       
   208 h1.toc                      { text-align: center; font-size: 105%;
       
   209                               margin: 0; font-weight: bold;
       
   210                               padding: 0; }
       
   211 h2.toc                      { font-size: 100%; font-weight: bold; 
       
   212                               margin: 0.5em 0 0 -0.3em; }
       
   213 
       
   214 /* Syntax Highlighting for Source Code
       
   215  *   - doctest examples are displayed in a 'pre.py-doctest' block.
       
   216  *     If the example is in a details table entry, then it will use
       
   217  *     the colors specified by the 'table pre.py-doctest' line.
       
   218  *   - Source code listings are displayed in a 'pre.py-src' block.
       
   219  *     Each line is marked with 'span.py-line' (used to draw a line
       
   220  *     down the left margin, separating the code from the line
       
   221  *     numbers).  Line numbers are displayed with 'span.py-lineno'.
       
   222  *     The expand/collapse block toggle button is displayed with
       
   223  *     'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not
       
   224  *     modify the font size of the text.)
       
   225  *   - If a source code page is opened with an anchor, then the
       
   226  *     corresponding code block will be highlighted.  The code
       
   227  *     block's header is highlighted with 'py-highlight-hdr'; and
       
   228  *     the code block's body is highlighted with 'py-highlight'.
       
   229  *   - The remaining py-* classes are used to perform syntax
       
   230  *     highlighting (py-string for string literals, py-name for names,
       
   231  *     etc.)
       
   232  */
       
   233 pre.py-doctest              { padding: .5em; margin: 1em;
       
   234                               background: #e8f0f8; color: #000000;
       
   235                               border: 1px solid #708890; }
       
   236 table pre.py-doctest        { background: #dce4ec;
       
   237                               color: #000000; }
       
   238 pre.py-src                  { border: 2px solid #000000; 
       
   239                               background: #f0f0f0; color: #000000; }
       
   240 .py-line                    { border-left: 2px solid #000000; 
       
   241                               margin-left: .2em; padding-left: .4em; }
       
   242 .py-lineno                  { font-style: italic; font-size: 90%;
       
   243                               padding-left: .5em; }
       
   244 a.py-toggle                 { text-decoration: none; }
       
   245 div.py-highlight-hdr        { border-top: 2px solid #000000;
       
   246                               border-bottom: 2px solid #000000;
       
   247                               background: #d8e8e8; }
       
   248 div.py-highlight            { border-bottom: 2px solid #000000;
       
   249                               background: #d0e0e0; }
       
   250 .py-prompt                  { color: #005050; font-weight: bold;}
       
   251 .py-more                    { color: #005050; font-weight: bold;}
       
   252 .py-string                  { color: #006030; }
       
   253 .py-comment                 { color: #003060; }
       
   254 .py-keyword                 { color: #600000; }
       
   255 .py-output                  { color: #404040; }
       
   256 .py-name                    { color: #000050; }
       
   257 .py-name:link               { color: #000050 !important; }
       
   258 .py-name:visited            { color: #000050 !important; }
       
   259 .py-number                  { color: #005000; }
       
   260 .py-defname                 { color: #000060; font-weight: bold; }
       
   261 .py-def-name                { color: #000060; font-weight: bold; }
       
   262 .py-base-class              { color: #000060; }
       
   263 .py-param                   { color: #000060; }
       
   264 .py-docstring               { color: #006030; }
       
   265 .py-decorator               { color: #804020; }
       
   266 /* Use this if you don't want links to names underlined: */
       
   267 /*a.py-name                   { text-decoration: none; }*/
       
   268 
       
   269 /* Graphs & Diagrams
       
   270  *   - These CSS styles are used for graphs & diagrams generated using
       
   271  *     Graphviz dot.  'img.graph-without-title' is used for bare
       
   272  *     diagrams (to remove the border created by making the image
       
   273  *     clickable).
       
   274  */
       
   275 img.graph-without-title     { border: none; }
       
   276 img.graph-with-title        { border: 1px solid #000000; }
       
   277 span.graph-title            { font-weight: bold; }
       
   278 span.graph-caption          { }
       
   279 
       
   280 /* General-purpose classes
       
   281  *   - 'p.indent-wrapped-lines' defines a paragraph whose first line
       
   282  *     is not indented, but whose subsequent lines are.
       
   283  *   - The 'nomargin-top' class is used to remove the top margin (e.g.
       
   284  *     from lists).  The 'nomargin' class is used to remove both the
       
   285  *     top and bottom margin (but not the left or right margin --
       
   286  *     for lists, that would cause the bullets to disappear.)
       
   287  */
       
   288 p.indent-wrapped-lines      { padding: 0 0 0 7em; text-indent: -7em; 
       
   289                               margin: 0; }
       
   290 .nomargin-top               { margin-top: 0; }
       
   291 .nomargin                   { margin-top: 0; margin-bottom: 0; }
       
   292 
       
   293 /* HTML Log */
       
   294 div.log-block               { padding: 0; margin: .5em 0 .5em 0;
       
   295                               background: #e8f0f8; color: #000000;
       
   296                               border: 1px solid #000000; }
       
   297 div.log-error               { padding: .1em .3em .1em .3em; margin: 4px;
       
   298                               background: #ffb0b0; color: #000000;
       
   299                               border: 1px solid #000000; }
       
   300 div.log-warning             { padding: .1em .3em .1em .3em; margin: 4px;
       
   301                               background: #ffffb0; color: #000000;
       
   302                               border: 1px solid #000000; }
       
   303 div.log-info               { padding: .1em .3em .1em .3em; margin: 4px;
       
   304                               background: #b0ffb0; color: #000000;
       
   305                               border: 1px solid #000000; }
       
   306 h2.log-hdr                  { background: #70b0ff; color: #000000;
       
   307                               margin: 0; padding: 0em 0.5em 0em 0.5em;
       
   308                               border-bottom: 1px solid #000000; font-size: 110%; }
       
   309 p.log                       { font-weight: bold; margin: .5em 0 .5em 0; }
       
   310 tr.opt-changed              { color: #000000; font-weight: bold; }
       
   311 tr.opt-default              { color: #606060; }
       
   312 pre.log                     { margin: 0; padding: 0; padding-left: 1em; }