epydoc.css 13 KB

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