index.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Welcome to the documentation for xdice &#8212; xdice 1.0.0 documentation</title>
  7. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: './',
  12. VERSION: '1.0.0',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true,
  16. SOURCELINK_SUFFIX: '.txt'
  17. };
  18. </script>
  19. <script type="text/javascript" src="_static/jquery.js"></script>
  20. <script type="text/javascript" src="_static/underscore.js"></script>
  21. <script type="text/javascript" src="_static/doctools.js"></script>
  22. <link rel="index" title="Index" href="genindex.html" />
  23. <link rel="search" title="Search" href="search.html" />
  24. <link rel="next" title="Introduction" href="introduction.html" />
  25. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body>
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <div class="section" id="welcome-to-the-documentation-for-xdice">
  34. <h1>Welcome to the documentation for xdice<a class="headerlink" href="#welcome-to-the-documentation-for-xdice" title="Permalink to this headline">¶</a></h1>
  35. <p>Contents:</p>
  36. <div class="toctree-wrapper compound">
  37. <ul>
  38. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
  39. <li class="toctree-l2"><a class="reference internal" href="introduction.html#presentation">Presentation</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="introduction.html#what-can-it-do">What can it do?</a><ul>
  41. <li class="toctree-l3"><a class="reference internal" href="introduction.html#examples">Examples</a></li>
  42. </ul>
  43. </li>
  44. </ul>
  45. </li>
  46. <li class="toctree-l1"><a class="reference internal" href="dice_notation.html">Dice Notation</a><ul>
  47. <li class="toctree-l2"><a class="reference internal" href="dice_notation.html#dice">Dice</a><ul>
  48. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#bases">Bases</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#default-values">Default values</a></li>
  50. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#d-notation">D% Notation</a></li>
  51. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#selective-results">Selective results</a></li>
  52. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#exploding-dice">Exploding dice</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l2"><a class="reference internal" href="dice_notation.html#patterns">Patterns</a><ul>
  56. <li class="toctree-l3"><a class="reference internal" href="dice_notation.html#repeat">Repeat</a></li>
  57. </ul>
  58. </li>
  59. <li class="toctree-l2"><a class="reference internal" href="dice_notation.html#examples">Examples</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l1"><a class="reference internal" href="cli.html">Command-Line</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a><ul>
  64. <li class="toctree-l2"><a class="reference internal" href="api.html#the-dice-module">The dice module</a><ul>
  65. <li class="toctree-l3"><a class="reference internal" href="api.html#dice-compile-pattern-string">dice.compile(pattern_string)</a></li>
  66. <li class="toctree-l3"><a class="reference internal" href="api.html#dice-roll-pattern-string">dice.roll(pattern_string)</a></li>
  67. <li class="toctree-l3"><a class="reference internal" href="api.html#dice-rolldice-faces-amount-1-drop-lowest-0-drop-highest-0">dice.rolldice(faces, amount=1, drop_lowest=0, drop_highest=0)</a></li>
  68. </ul>
  69. </li>
  70. <li class="toctree-l2"><a class="reference internal" href="api.html#dice-class">Dice class</a><ul>
  71. <li class="toctree-l3"><a class="reference internal" href="api.html#dice-init-sides-amount-1-drop-lowest-0-drop-highest-0">Dice.__init__ (sides, amount=1, drop_lowest=0, drop_highest=0)</a></li>
  72. <li class="toctree-l3"><a class="reference internal" href="api.html#properties">Properties</a></li>
  73. <li class="toctree-l3"><a class="reference internal" href="api.html#dice-roll">dice.roll()</a></li>
  74. <li class="toctree-l3"><a class="reference internal" href="api.html#classmethod-dice-parse-cls-pattern"><em>[classmethod]</em> Dice.parse(cls, pattern)</a></li>
  75. </ul>
  76. </li>
  77. <li class="toctree-l2"><a class="reference internal" href="api.html#score-class">Score class</a><ul>
  78. <li class="toctree-l3"><a class="reference internal" href="api.html#score-new-iterable-dropped-name">Score.__new__(iterable, dropped=[], name=’‘)</a></li>
  79. <li class="toctree-l3"><a class="reference internal" href="api.html#id1">Properties</a></li>
  80. <li class="toctree-l3"><a class="reference internal" href="api.html#score-format-verbose-false">score.format(verbose=False)</a></li>
  81. </ul>
  82. </li>
  83. <li class="toctree-l2"><a class="reference internal" href="api.html#pattern-class">Pattern class</a><ul>
  84. <li class="toctree-l3"><a class="reference internal" href="api.html#pattern-init-instr">Pattern.__init__ (instr)</a></li>
  85. <li class="toctree-l3"><a class="reference internal" href="api.html#pattern-compile">pattern.compile()</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="api.html#pattern-roll">pattern.roll()</a></li>
  87. </ul>
  88. </li>
  89. <li class="toctree-l2"><a class="reference internal" href="api.html#patternscore-class">PatternScore class</a><ul>
  90. <li class="toctree-l3"><a class="reference internal" href="api.html#pattern-score-scores">pattern_score.scores()</a></li>
  91. <li class="toctree-l3"><a class="reference internal" href="api.html#pattern-score-format-verbose-false">pattern_score.format(verbose=False)</a></li>
  92. </ul>
  93. </li>
  94. </ul>
  95. </li>
  96. </ul>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. </div>
  102. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  103. <div class="sphinxsidebarwrapper">
  104. <h1 class="logo"><a href="#">xdice</a></h1>
  105. <h3>Navigation</h3>
  106. <ul>
  107. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  108. <li class="toctree-l1"><a class="reference internal" href="dice_notation.html">Dice Notation</a></li>
  109. <li class="toctree-l1"><a class="reference internal" href="cli.html">Command-Line</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
  111. </ul>
  112. <div class="relations">
  113. <h3>Related Topics</h3>
  114. <ul>
  115. <li><a href="#">Documentation overview</a><ul>
  116. <li>Next: <a href="introduction.html" title="next chapter">Introduction</a></li>
  117. </ul></li>
  118. </ul>
  119. </div>
  120. <div id="searchbox" style="display: none" role="search">
  121. <h3>Quick search</h3>
  122. <form class="search" action="search.html" method="get">
  123. <div><input type="text" name="q" /></div>
  124. <div><input type="submit" value="Go" /></div>
  125. <input type="hidden" name="check_keywords" value="yes" />
  126. <input type="hidden" name="area" value="default" />
  127. </form>
  128. </div>
  129. <script type="text/javascript">$('#searchbox').show(0);</script>
  130. </div>
  131. </div>
  132. <div class="clearer"></div>
  133. </div>
  134. <div class="footer">
  135. &copy;2017, Olivier Massot.
  136. |
  137. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
  138. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
  139. |
  140. <a href="_sources/index.rst.txt"
  141. rel="nofollow">Page source</a>
  142. </div>
  143. </body>
  144. </html>