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.

index.rst 8.2 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. ===================
  2. Sphinx Nameko Theme
  3. ===================
  4. A fork of `Sphinx Readable Theme <https://github.com/ignacysokolowski/sphinx-readable-theme>`_ for use in `Nameko <https://github.com/onefinestay/nameko>`_.
  5. Installation and setup
  6. ======================
  7. Install from PyPI::
  8. $ pip install sphinx-nameko-theme
  9. And add this to your ``conf.py``:
  10. .. code-block:: python
  11. import sphinx_nameko_theme
  12. html_theme_path = [sphinx_nameko_theme.get_html_theme_path()]
  13. html_theme = 'nameko'
  14. License
  15. =======
  16. Sphinx Nameko Theme is licensed under the MIT license.
  17. Changelog
  18. =========
  19. Version 0.0.1
  20. -------------
  21. First release.
  22. Theme style
  23. ===========
  24. .. index::
  25. single: Headings
  26. Headings
  27. --------
  28. .. raw:: html
  29. <h1>H1: Lorem ipsum dolor sit amet</h1>
  30. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  31. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  32. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  33. .. raw:: html
  34. <h2>H2: Lorem ipsum dolor sit amet</h2>
  35. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  36. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  37. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  38. .. raw:: html
  39. <h3>H3: Lorem ipsum dolor sit amet</h3>
  40. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  41. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  42. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  43. .. raw:: html
  44. <h4>H4: Lorem ipsum dolor sit amet</h4>
  45. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  46. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  47. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  48. .. raw:: html
  49. <h5>H5: Lorem ipsum dolor sit amet</h5>
  50. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  51. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  52. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  53. .. raw:: html
  54. <h6>H6: Lorem ipsum dolor sit amet</h6>
  55. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
  56. incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
  57. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  58. .. index::
  59. single: Paragraphs
  60. Paragraphs
  61. ----------
  62. Duis **aute irure dolor** in `reprehenderit` in voluptate velit esse cillum
  63. dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
  64. proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
  65. `Lorem ipsum`_ dolor sit amet, consectetur adipisicing elit, sed do eiusmod
  66. tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
  67. quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
  68. consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
  69. cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat `cupidatat`_
  70. non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
  71. .. _footnotes:
  72. Footnotes
  73. ---------
  74. .. target-notes::
  75. .. _Lorem ipsum: http://www.google.com
  76. .. _`cupidatat`: http://docutils.sourceforge.net/rst.html
  77. .. index::
  78. single: Tables
  79. Tables
  80. ------
  81. +----------------------+------------------------------------------------+
  82. | Header row, column 1 | Header row, column 2 |
  83. +======================+================================================+
  84. | body row 1 | Second column of row 1 |
  85. +----------------------+------------------------------------------------+
  86. | body row 2 | Second column of row 2 |
  87. | | |
  88. | | Second line of paragraph |
  89. +----------------------+------------------------------------------------+
  90. | body row 3 | Unordered list: |
  91. | | |
  92. | | * Second column of row 3 |
  93. | | * Second item in bullet list (row 3, column 2) |
  94. +----------------------+------------------------------------------------+
  95. | \ | Row 4; column 1 will be empty |
  96. +----------------------+------------------------------------------------+
  97. .. index::
  98. single: Lists
  99. Lists
  100. -----
  101. Unordered list
  102. ~~~~~~~~~~~~~~
  103. * Lorem ipsum
  104. * Dolor sit amet
  105. * Dolor
  106. * Sit
  107. * Amet
  108. * Consectetur adipiscing elit
  109. Ordered list
  110. ~~~~~~~~~~~~
  111. #. Lorem ipsum
  112. #. Dolor sit amet
  113. #. Dolor
  114. #. Sit
  115. #. Amet
  116. #. Consectetur adipiscing elit
  117. Definition Lists
  118. ~~~~~~~~~~~~~~~~
  119. Lorem
  120. Lorem ipsum dolor sit amet.
  121. Ipsum
  122. Ipsum dolor amet sit.
  123. Dolor : classifier
  124. Dolor lorem ipsum.
  125. Sit amet : classifier one : classifier two
  126. Sit amet consectetur adipiscing elit.
  127. .. index::
  128. single: Topics
  129. .. _topic:
  130. Topics
  131. ------
  132. .. topic:: Lorem ipsum
  133. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
  134. tempor incididunt ut labore et dolore magna aliqua.
  135. Sidebars
  136. --------
  137. .. sidebar:: Sidebar title
  138. Lorem ipsum dolor sit amet, nunc iaculis nulla molestie neque varius vulputate. Aenean hendrerit condimentum arcu ut porta.
  139. 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.
  140. 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.
  141. .. index::
  142. single: Admonitions
  143. .. _admonitions:
  144. Admonitions
  145. -----------
  146. .. admonition:: Admonition title
  147. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  148. .. attention::
  149. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  150. .. caution::
  151. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  152. .. danger::
  153. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  154. .. error::
  155. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  156. .. hint::
  157. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  158. .. important::
  159. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  160. .. note::
  161. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  162. .. seealso::
  163. Module :py:mod:`zipfile`
  164. Documentation of the :py:mod:`zipfile` standard module.
  165. `GNU tar manual, Basic Tar Format <http://link>`_
  166. Documentation for tar archive files, including GNU tar extensions.
  167. .. tip::
  168. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  169. .. warning::
  170. Lorem ipsum dolor sit amet, consectetur adipisicing elit.
  171. .. index::
  172. single: Code
  173. Code
  174. ----
  175. .. code-block:: python
  176. """An example module docstring to show Pygments style."""
  177. # Some comment.
  178. import datetime
  179. from functools import partial
  180. number = 123
  181. word = 'foo'
  182. class ExampleClass(object):
  183. """An example class docstring to show Pygments style."""
  184. def __init__(self, arg1, arg2=None, *args, **kwargs):
  185. self.attr1 = attr1
  186. self.attr2 = attr2 or datetime.datetime.now()
  187. for arg in args:
  188. print('Argument: '.format(arg))
  189. for k, v in kwargs.iteritems():
  190. print('Keyword argument named {}: {}'.format(k, v))
  191. def call_method(self, arg):
  192. """An example method docstring."""
  193. if not isinstance(arg, int):
  194. raise ValueError('Only ints allowed.')
  195. self.attr1 = arg
  196. @property
  197. def example_property(self):
  198. """An example property docstring."""
  199. return self.attr1 * 2
  200. def example_function(arg1, arg2=None, *args, **kwargs):
  201. """An example function docstring to show Pygments style."""
  202. raise NotImplementedError()
  203. .. index::
  204. single: Autodoc
  205. Autodoc
  206. ~~~~~~~
  207. .. automodule:: example