A fork of Sphinx Readable Theme for use in Nameko.
Install from PyPI:
$ pip install sphinx-nameko-theme
And add this to your conf.py:
import sphinx_nameko_theme
html_theme_path = [sphinx_nameko_theme.get_html_theme_path()]
html_theme = 'nameko'
Sphinx Nameko Theme is licensed under the MIT license.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Lorem ipsum [1] dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat [2] non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Header row, column 1 | Header row, column 2 |
---|---|
body row 1 | Second column of row 1 |
body row 2 | Second column of row 2 Second line of paragraph |
body row 3 | Unordered list:
|
Row 4; column 1 will be empty |
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
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.
Admonition title
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Attention
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Caution
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Danger
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Error
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Hint
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Important
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Note
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
See also
Tip
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
Warning
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
"""An example module docstring to show Pygments style."""
# Some comment.
import datetime
from functools import partial
number = 123
word = 'foo'
class ExampleClass(object):
"""An example class docstring to show Pygments style."""
def __init__(self, arg1, arg2=None, *args, **kwargs):
self.attr1 = attr1
self.attr2 = attr2 or datetime.datetime.now()
for arg in args:
print('Argument: '.format(arg))
for k, v in kwargs.iteritems():
print('Keyword argument named {}: {}'.format(k, v))
def call_method(self, arg):
"""An example method docstring."""
if not isinstance(arg, int):
raise ValueError('Only ints allowed.')
self.attr1 = arg
@property
def example_property(self):
"""An example property docstring."""
return self.attr1 * 2
def example_function(arg1, arg2=None, *args, **kwargs):
"""An example function docstring to show Pygments style."""
raise NotImplementedError()
An example module to show autodoc style.
Contains an example constant, Storage class for storing objects and helper function store_integers() for storing only integers.
Example integer constant.
Example integer constant.
Bases: object
A class for storing objects.
This is an example class to show autodoc style.
It stores a list of objects and saves date of last appended item. Example usage:
>>> storage = Storage(['foo', 'bar'])
>>> storage.items
['foo', 'bar']
>>> storage.last_updated
datetime.datetime(2013, 8, 15, 13, 41, 38, 515797)
>>> storage.add_item('baz')
>>> storage.items
['foo', 'bar', 'baz']
>>> storage.last_updated
datetime.datetime(2013, 8, 15, 13, 41, 40, 595544)
Parameters: | items – Optional list of items to start with. |
---|
List of items, add new item using add_item().
datetime.datetime of last item update, will be set to datetime.datetime.now() on object instantiation.
Append item to the list.
last_updated will be set to datetime.datetime.now().
Parameters: | item – Something to append to items. |
---|
Store integers from the given list in a storage.
This is an example function to show autodoc style.
Return Storage instance with integers from the given list.
Examples:
>>> storage = store_integers([1, 'foo', 2, 'bar', 0])
>>> storage.items
[1, 2, 0]
>>> storage = store_integers([1, 'foo', 2, 'bar', 0], allow_zero=False)
>>> storage.items
[1, 2]
Parameters: |
|
---|