Skip to content

Instantly share code, notes, and snippets.

@ShadowKyogre
Last active July 13, 2016 19:53
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ShadowKyogre/1e2aae8f2db0b9cfe604a136907f0e8d to your computer and use it in GitHub Desktop.
Save ShadowKyogre/1e2aae8f2db0b9cfe604a136907f0e8d to your computer and use it in GitHub Desktop.
Sphinx Theming Test Cases
'''
I AM A MODULE LEVEL DOCSTRING
.. topic:: Topic Title
Subsequent indented lines comprise
the body of the topic, and are
interpreted as body elements.
.. attention::
I am an attention-grabbing thing
.. caution::
I am a caution
.. danger::
I am a danger
.. error::
I am an error
.. hint::
I am a hint
.. tip::
I am a tip
.. important::
I am important
.. note::
I am a note
.. warning::
I am a warning
:class:`Pokemon`
.. admonition:: Some title
I am an admonition
'''
class Pokemon:
'''
IT'S A POKEMON!
===== ===== =======
A B A and B
===== ===== =======
False False False
True False False
False True False
True True True
===== ===== =======
blabla
SO LITERAL
Parameters
----------
element1 : str
first element
I am multi line
element2 : str or None
second element, opt
_hp : int
base HP
_atk : int
base ATK
_def : int
base DEF
_satk : int
base S. ATK
_sdef : int
base S. DEF
_spd : int
base SPEED
'''
def __init__(self, element1, element2, ability, _hp, _atk, _def, _satk, _sdef, _spd):
'''
Basic Pokemon stat block.
'''
pass
class Move:
'''
Basic move info
LLALALWLELAWEWL
.. code-block:: python
:emphasize-lines: 3,5
def some_function():
interesting = False
print 'This line is highlighted.'
print 'This one is not...'
print '...but this one is.'
Parameters
----------
element1
yes
element2
no
base_pow
maybe
See Also
--------
Pokemon
'''
def __init__(self, element1, base_pow):
pass
def func(arg1, arg2):
"""Summary line.
Parameters
----------
arg1 : int
Description of arg1
arg2 : str
Description of arg2
"""
return True
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment