Skip to content

Commit

Permalink
Rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
olinox14 committed Sep 24, 2017
1 parent c239b85 commit e43dbc5
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 379 deletions.
131 changes: 0 additions & 131 deletions docs/API.md

This file was deleted.

29 changes: 0 additions & 29 deletions docs/CLI Usage.md

This file was deleted.

34 changes: 16 additions & 18 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ API
xdice.compile(pattern\_string)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Similar to ``xdice.Pattern(pattern_string).compile()``*
Similar to `xdice.Pattern(pattern_string).compile()`

Returns a compiled Pattern object.

Expand All @@ -13,20 +13,19 @@ xdice.compile(pattern\_string)
xdice.roll(pattern\_string)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Similar to ``xdice.Pattern(pattern_string).roll()``*
Similar to `xdice.Pattern(pattern_string).roll()`

xdice.rolldice(faces, amount=1, drop\_lowest=0, drop\_highest=0)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*Similar to
``xdice.Dice(faces, amount, drop_lowest, drop_highest).roll()``*
Similar to `xdice.Dice(faces, amount, drop_lowest, drop_highest).roll()`

Dice object
-----------

Set of dice.

Dice.\ **init**\ (sides, amount=1, drop\_lowest=0, drop\_highest=0)
Dice.__init__ (sides, amount=1, drop\_lowest=0, drop\_highest=0)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Instantiate a set of dice.
Expand All @@ -43,14 +42,15 @@ dice.roll()
integers, then return the corresponding Dice object. Use
‘AdX[Ln][Hn]’ to drop the n lowest and/or highest dice when rolled.


Properties
~~~~~~~~~~
^^^^^^^^^^

- ``dice.sides``: number of sides of the dice
- ``dice.amount``: amount of dice to roll
- ``dice.drop_lowest``: amount of lowest scores to drop
- ``dice.drop_highest``: amount of highest scores to drop
- ``dice.name`` : Decsriptive name of the Dice object
- `dice.sides`: number of sides of the dice
- `dice.amount`: amount of dice to roll
- `dice.drop_lowest`: amount of lowest scores to drop
- `dice.drop_highest`: amount of highest scores to drop
- `dice.name` : Descriptive name of the Dice object

Score object
------------
Expand All @@ -76,10 +76,10 @@ Score object
>>> list(s)
[1,2,3]

Score.\ **new**\ (iterable, dropped=\ ``_, name=“”)
Score.__new__(iterable, dropped=[], name='')
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*``iterable`` should only contain integers*
`iterable` should only contain integers

Score value will be the sum of the list’s values.

Expand All @@ -89,7 +89,7 @@ score.format(verbose=False)
A formatted string describing the detailed result.

Properties
~~~~~~~~~~
^^^^^^^^^^

- score.detail: similar to list(score), return the list of the
individual results
Expand All @@ -101,7 +101,7 @@ Pattern object

Dice notation pattern.

Pattern.\ **init**\ (instr)
Pattern.__init__ (instr)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Instantiate a Pattern object.
Expand Down Expand Up @@ -145,6 +145,4 @@ pattern\_score.scores()
^^^^^^^^^^^^^^^^^^^^^^^

Returns the list of Score objects extracted from the pattern and
rolled.

.. _: #section
rolled.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.md'
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'
Expand Down
71 changes: 0 additions & 71 deletions docs/dice_notation.md

This file was deleted.

Loading

0 comments on commit e43dbc5

Please sign in to comment.