E2L_Ivry
/
cours-python
5
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
408 Commits
1 Branch
12 MiB
 
 
 
 
 
 
Tree: 40dc6e45c7
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '40dc6e45c7'
${ noResults }
cours-python/cours/theme/nameko/docs/source/index.rst

324 lines
8.2 KiB
Raw Blame History 

  1. ===================

  2. Sphinx Nameko Theme

  3. ===================

  4. 

  5. A fork of `Sphinx Readable Theme <https://github.com/ignacysokolowski/sphinx-readable-theme>`_ for use in `Nameko <https://github.com/onefinestay/nameko>`_.

  6. 

  7. 

  8. Installation and setup

  9. ======================

  10. 

  11. 

  12. Install from PyPI::

  13. 

  14.     $ pip install sphinx-nameko-theme

  15. 

  16. And add this to your ``conf.py``:

  17. 

  18. .. code-block:: python

  19. 

  20.     import sphinx_nameko_theme

  21. 

  22.     html_theme_path = [sphinx_nameko_theme.get_html_theme_path()]

  23.     html_theme = 'nameko'

  24. 

  25. 

  26. License

  27. =======

  28. 

  29. Sphinx Nameko Theme is licensed under the MIT license.

  30. 

  31. 

  32. Changelog

  33. =========

  34. 

  35. Version 0.0.1

  36. -------------

  37. 

  38. First release.

  39. 

  40. 

  41. Theme style

  42. ===========

  43. 

  44. .. index::

  45.    single: Headings

  46. 

  47. Headings

  48. --------

  49. 

  50. .. raw:: html

  51. 

  52.    <h1>H1: Lorem ipsum dolor sit amet</h1>

  53. 

  54. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  55. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  56. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  57. 

  58. .. raw:: html

  59. 

  60.    <h2>H2: Lorem ipsum dolor sit amet</h2>

  61. 

  62. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  63. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  64. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  65. 

  66. .. raw:: html

  67. 

  68.    <h3>H3: Lorem ipsum dolor sit amet</h3>

  69. 

  70. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  71. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  72. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  73. 

  74. .. raw:: html

  75. 

  76.    <h4>H4: Lorem ipsum dolor sit amet</h4>

  77. 

  78. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  79. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  80. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  81. 

  82. .. raw:: html

  83. 

  84.    <h5>H5: Lorem ipsum dolor sit amet</h5>

  85. 

  86. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  87. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  88. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  89. 

  90. .. raw:: html

  91. 

  92.    <h6>H6: Lorem ipsum dolor sit amet</h6>

  93. 

  94. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor

  95. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis

  96. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

  97. 

  98. 

  99. .. index::

  100.    single: Paragraphs

  101. 

  102. Paragraphs

  103. ----------

  104. 

  105. Duis **aute irure dolor** in `reprehenderit` in voluptate velit esse cillum

  106. dolore eu fugiat nulla pariatur.  Excepteur sint occaecat cupidatat non

  107. proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

  108. 

  109. `Lorem ipsum`_ dolor sit amet, consectetur adipisicing elit, sed do eiusmod

  110. tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim veniam,

  111. quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo

  112. consequat.  Duis aute irure dolor in reprehenderit in voluptate velit esse

  113. cillum dolore eu fugiat nulla pariatur.  Excepteur sint occaecat `cupidatat`_

  114. non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

  115. 

  116. 

  117. 

  118. .. _footnotes:

  119. 

  120. Footnotes

  121. ---------

  122. 

  123. .. target-notes::

  124. 

  125. .. _Lorem ipsum: http://www.google.com

  126. .. _`cupidatat`: http://docutils.sourceforge.net/rst.html

  127. 

  128. 

  129. .. index::

  130.    single: Tables

  131. 

  132. Tables

  133. ------

  134. 

  135. +----------------------+------------------------------------------------+

  136. | Header row, column 1 | Header row, column 2                           |

  137. +======================+================================================+

  138. | body row 1           | Second column of row 1                         |

  139. +----------------------+------------------------------------------------+

  140. | body row 2           | Second column of row 2                         |

  141. |                      |                                                |

  142. |                      | Second line of paragraph                       |

  143. +----------------------+------------------------------------------------+

  144. | body row 3           | Unordered list:                                |

  145. |                      |                                                |

  146. |                      | * Second column of row 3                       |

  147. |                      | * Second item in bullet list (row 3, column 2) |

  148. +----------------------+------------------------------------------------+

  149. | \                    | Row 4; column 1 will be empty                  |

  150. +----------------------+------------------------------------------------+

  151. 

  152. 

  153. .. index::

  154.    single: Lists

  155. 

  156. Lists

  157. -----

  158. 

  159. Unordered list

  160. ~~~~~~~~~~~~~~

  161. 

  162. * Lorem ipsum

  163. * Dolor sit amet

  164. 

  165.   * Dolor

  166.   * Sit

  167.   * Amet

  168. 

  169. * Consectetur adipiscing elit

  170. 

  171. Ordered list

  172. ~~~~~~~~~~~~

  173. 

  174. #. Lorem ipsum

  175. #. Dolor sit amet

  176. 

  177.    #. Dolor

  178.    #. Sit

  179.    #. Amet

  180. 

  181. #. Consectetur adipiscing elit

  182. 

  183. Definition Lists

  184. ~~~~~~~~~~~~~~~~

  185. 

  186. Lorem

  187.     Lorem ipsum dolor sit amet.

  188. Ipsum

  189.     Ipsum dolor amet sit.

  190. Dolor : classifier

  191.     Dolor lorem ipsum.

  192. Sit amet : classifier one : classifier two

  193.     Sit amet consectetur adipiscing elit.

  194. 

  195. 

  196. .. index::

  197.    single: Topics

  198. 

  199. .. _topic:

  200. 

  201. Topics

  202. ------

  203. 

  204. .. topic:: Lorem ipsum

  205. 

  206.    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod

  207.    tempor incididunt ut labore et dolore magna aliqua.

  208. 

  209. Sidebars

  210. --------

  211. 

  212. .. sidebar:: Sidebar title

  213. 

  214.    Lorem ipsum dolor sit amet, nunc iaculis nulla molestie neque varius vulputate. Aenean hendrerit condimentum arcu ut porta.

  215. 

  216.    Nullam ac velit lobortis, tincidunt est varius, condimentum lectus. In eu sapien nec lacus interdum ultricies. Aliquam in luctus metus. Nulla mattis, sem quis fringilla pharetra, dui eros consequat velit, at bibendum Mauris sed velit non nibh aliquet mattis.

  217. 

  218. Mauris sed velit non nibh aliquet mattis. Nullam ac velit lobortis, tincidunt est varius, condimentum lectus. In eu sapien nec lacus interdum ultricies. Aliquam in luctus metus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

  219. 

  220. 

  221. .. index::

  222.    single: Admonitions

  223. 

  224. .. _admonitions:

  225. 

  226. Admonitions

  227. -----------

  228. 

  229. .. admonition:: Admonition title

  230. 

  231.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  232. 

  233. .. attention::

  234.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  235. 

  236. .. caution::

  237.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  238. 

  239. .. danger::

  240.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  241. 

  242. .. error::

  243.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  244. 

  245. .. hint::

  246.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  247. 

  248. .. important::

  249.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  250. 

  251. .. note::

  252.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  253. 

  254. .. seealso::

  255. 

  256.    Module :py:mod:`zipfile`

  257.       Documentation of the :py:mod:`zipfile` standard module.

  258. 

  259.    `GNU tar manual, Basic Tar Format <http://link>`_

  260.       Documentation for tar archive files, including GNU tar extensions.

  261. 

  262. .. tip::

  263.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  264. 

  265. .. warning::

  266.    Lorem ipsum dolor sit amet, consectetur adipisicing elit.

  267. 

  268. 

  269. .. index::

  270.    single: Code

  271. 

  272. Code

  273. ----

  274. 

  275. .. code-block:: python

  276. 

  277.   """An example module docstring to show Pygments style."""

  278. 

  279.   # Some comment.

  280. 

  281.   import datetime

  282.   from functools import partial

  283. 

  284.   number = 123

  285.   word = 'foo'

  286. 

  287. 

  288.   class ExampleClass(object):

  289. 

  290.       """An example class docstring to show Pygments style."""

  291. 

  292.       def __init__(self, arg1, arg2=None, *args, **kwargs):

  293.           self.attr1 = attr1

  294.           self.attr2 = attr2 or datetime.datetime.now()

  295.           for arg in args:

  296.               print('Argument: '.format(arg))

  297.           for k, v in kwargs.iteritems():

  298.               print('Keyword argument named {}: {}'.format(k, v))

  299. 

  300.       def call_method(self, arg):

  301.           """An example method docstring."""

  302.           if not isinstance(arg, int):

  303.               raise ValueError('Only ints allowed.')

  304.           self.attr1 = arg

  305. 

  306.       @property

  307.       def example_property(self):

  308.           """An example property docstring."""

  309.           return self.attr1 * 2

  310. 

  311. 

  312.   def example_function(arg1, arg2=None, *args, **kwargs):

  313.       """An example function docstring to show Pygments style."""

  314.       raise NotImplementedError()

  315. 

  316. 

  317. .. index::

  318.    single: Autodoc

  319. 

  320. Autodoc

  321. ~~~~~~~

  322. 

  323. .. automodule:: example