Skip to content

Commit

Permalink
Experiment with online ReadTheDocs doc generation by adding subdirect…
Browse files Browse the repository at this point in the history 
…ories rst_from_demos/ and markdown_to_rst/ in python_prototype/sphinx/.
  • Loading branch information
@schoi32
schoi32 committed Dec 24, 2019
1 parent eb37df9 commit a6e8359
Show file tree
Hide file tree
Showing 57 changed files with 3,587 additions and 1,100 deletions.
2 changes: 0 additions & 2 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ docs/Gemfile.lock
# Sphinx
python_prototype/sphinx/_build/
python_prototype/sphinx/_static/
python_prototype/sphinx/rst_from_demos/
python_prototype/sphinx/rts_from_readme/

# Jupyter Notebooks
*checkpoint.ipynb
Expand Down
Binary file modified docs/_images/nei_demo_13_0.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/nei_demo_5_0.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/nei_demo_7_0.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/nei_demo_9_0.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...urces/rts_from_readme/QMCSoftware.rst.txt → ...urces/markdown_to_rst/QMCSoftware.rst.txt
View file
File renamed without changes.
0 .../rts_from_readme/python_prototype.rst.txt → .../markdown_to_rst/python_prototype.rst.txt
View file
File renamed without changes.
0 docs/_sources/rts_from_readme/qmcpy.rst.txt → docs/_sources/markdown_to_rst/qmcpy.rst.txt
View file
File renamed without changes.
0 docs/_sources/rts_from_readme/test.rst.txt → docs/_sources/markdown_to_rst/test.rst.txt
View file
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/_sources/readme.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ About Our QMC Software Community
.. toctree::
:maxdepth: 1

rts_from_readme/QMCSoftware.rst
markdown_to_rst/QMCSoftware.rst

rts_from_readme/python_prototype.rst
markdown_to_rst/python_prototype.rst

rts_from_readme/qmcpy.rst
markdown_to_rst/qmcpy.rst

rts_from_readme/test.rst
markdown_to_rst/test.rst
524 changes: 262 additions & 262 deletions docs/_sources/rst_from_demos/MC_vs_QMC.rst.txt
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/_sources/rst_from_demos/integration_examples.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Sobol Discrete Distribution: -
n 128
n_total 128
confid_int [ 2.164 2.179]
time_total 0.008
time_total 0.007
r 16
Expand Down Expand Up @@ -117,7 +117,7 @@ Lattice Discrete Distribution: -
n 2048
n_total 2048
confid_int [ 5.833 5.838]
time_total 0.318
time_total 0.350
r 16
Expand Down Expand Up @@ -163,7 +163,7 @@ Multi-Level
.. parsed-literal::
Solution: 5.8344
Solution: 5.8359
AsianCall (Integrand Object)
volatility [ 0.500 0.500 0.500]
start_price [30 30 30]
Expand All @@ -185,10 +185,10 @@ Multi-Level
inflate 1.200
alpha 0.010
MeanVarData (AccumData Object)
n [ 249427.000 31202.000 5566.000]
n_total 289267
confid_int [ 5.786 5.883]
time_total 0.093
n [ 243544.000 33734.000 6776.000]
n_total 287126
confid_int [ 5.787 5.885]
time_total 0.123
18 changes: 9 additions & 9 deletions docs/_sources/rst_from_demos/qmcpy_intro.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ QMCPy and then invoke QMCPy’s integrate function:
.. parsed-literal::
Solution: 0.6581
Solution: 0.6570
QuickConstruct (Integrand Object)
IIDStdUniform (Discrete Distribution Object)
mimics StdUniform
Expand All @@ -227,10 +227,10 @@ QMCPy and then invoke QMCPy’s integrate function:
inflate 1.200
alpha 0.010
MeanVarData (AccumData Object)
n 3433
n_total 4457
confid_int [ 0.648 0.668]
time_total 0.003
n 3474
n_total 4498
confid_int [ 0.647 0.667]
time_total 0.002
Expand Down Expand Up @@ -266,7 +266,7 @@ changing the input parameter value of dimension for QuickConstruct
.. parsed-literal::
Solution: 0.8219
Solution: 0.8265
QuickConstruct (Integrand Object)
IIDStdUniform (Discrete Distribution Object)
mimics StdUniform
Expand All @@ -281,9 +281,9 @@ changing the input parameter value of dimension for QuickConstruct
inflate 1.200
alpha 0.010
MeanVarData (AccumData Object)
n 5388
n_total 6412
confid_int [ 0.812 0.832]
n 5283
n_total 6307
confid_int [ 0.816 0.837]
time_total 0.002
Expand Down
492 changes: 246 additions & 246 deletions docs/_sources/rst_from_demos/quasirandom_generators.rst.txt
View file

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,36 +157,36 @@ <h1>Qmcpy Documentation<a class="headerlink" href="#qmcpy-documentation" title="
<p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="readme.html">About Our QMC Software Community</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/QMCSoftware.html">Quasi-Monte Carlo Community Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/QMCSoftware.html#citation">Citation</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/QMCSoftware.html#developers">Developers</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/QMCSoftware.html#contributors">Contributors</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/QMCSoftware.html#acknowledgment">Acknowledgment</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/QMCSoftware.html#references">References</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html">Quasi-Monte Carlo Community Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html#citation">Citation</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html#developers">Developers</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html#contributors">Contributors</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html#acknowledgment">Acknowledgment</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html#references">References</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/python_prototype.html">Python 3 Library of QMC Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#qmcpy">QMCPy</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#workouts">workouts</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#test">test</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#outputs">outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#demos">demos</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#sphinx">sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/python_prototype.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/python_prototype.html">Python 3 Library of QMC Software</a><ul>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#qmcpy">QMCPy</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#workouts">workouts</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#test">test</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#outputs">outputs</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#demos">demos</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#sphinx">sphinx</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/python_prototype.html#installation">Installation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/qmcpy.html">QMCPy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#integrand">Integrand</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#true-measure">True Measure</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#discrete-distribution">Discrete Distribution</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#stopping-criterion">Stopping Criterion</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#accumulate-data-class">Accumulate Data Class</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/qmcpy.html#integrate-method">Integrate Method</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/qmcpy.html">QMCPy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#integrand">Integrand</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#true-measure">True Measure</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#discrete-distribution">Discrete Distribution</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#stopping-criterion">Stopping Criterion</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#accumulate-data-class">Accumulate Data Class</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/qmcpy.html#integrate-method">Integrate Method</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/test.html">Tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/test.html#fast-unittests">Fast unittests</a></li>
<li class="toctree-l3"><a class="reference internal" href="rts_from_readme/test.html#long-unittests">Long unittests</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/test.html">Tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/test.html#fast-unittests">Fast unittests</a></li>
<li class="toctree-l3"><a class="reference internal" href="markdown_to_rst/test.html#long-unittests">Long unittests</a></li>
</ul>
</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="QMCPy Documentation" href="algorithms.html" />
<link rel="prev" title="Tests" href="rts_from_readme/test.html" />
<link rel="prev" title="Tests" href="markdown_to_rst/test.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -220,7 +220,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
<a href="algorithms.html" class="btn btn-neutral float-right" title="QMCPy Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="rts_from_readme/test.html" class="btn btn-neutral float-left" title="Tests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="markdown_to_rst/test.html" class="btn btn-neutral float-left" title="Tests" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
0 docs/rts_from_readme/QMCSoftware.html → docs/markdown_to_rst/QMCSoftware.html
View file
File renamed without changes.
0 docs/rts_from_readme/python_prototype.html → docs/markdown_to_rst/python_prototype.html
View file
File renamed without changes.
0 docs/rts_from_readme/qmcpy.html → docs/markdown_to_rst/qmcpy.html
View file
File renamed without changes.
0 docs/rts_from_readme/test.html → docs/markdown_to_rst/test.html
View file
File renamed without changes.
Binary file modified docs/objects.inv
View file
Binary file not shown.
Binary file modified docs/qmcpy.pdf
View file
Binary file not shown.
20 changes: 10 additions & 10 deletions docs/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Quasi-Monte Carlo Community Software" href="rts_from_readme/QMCSoftware.html" />
<link rel="next" title="Quasi-Monte Carlo Community Software" href="markdown_to_rst/QMCSoftware.html" />
<link rel="prev" title="Qmcpy Documentation" href="index.html" />
</head>

Expand Down Expand Up @@ -86,10 +86,10 @@
<p class="caption"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">About Our QMC Software Community</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/QMCSoftware.html">Quasi-Monte Carlo Community Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/python_prototype.html">Python 3 Library of QMC Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/qmcpy.html">QMCPy</a></li>
<li class="toctree-l2"><a class="reference internal" href="rts_from_readme/test.html">Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html">Quasi-Monte Carlo Community Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/python_prototype.html">Python 3 Library of QMC Software</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/qmcpy.html">QMCPy</a></li>
<li class="toctree-l2"><a class="reference internal" href="markdown_to_rst/test.html">Tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
Expand Down Expand Up @@ -162,10 +162,10 @@
<h1>About Our QMC Software Community<a class="headerlink" href="#about-our-qmc-software-community" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rts_from_readme/QMCSoftware.html">Quasi-Monte Carlo Community Software</a></li>
<li class="toctree-l1"><a class="reference internal" href="rts_from_readme/python_prototype.html">Python 3 Library of QMC Software</a></li>
<li class="toctree-l1"><a class="reference internal" href="rts_from_readme/qmcpy.html">QMCPy</a></li>
<li class="toctree-l1"><a class="reference internal" href="rts_from_readme/test.html">Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown_to_rst/QMCSoftware.html">Quasi-Monte Carlo Community Software</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown_to_rst/python_prototype.html">Python 3 Library of QMC Software</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown_to_rst/qmcpy.html">QMCPy</a></li>
<li class="toctree-l1"><a class="reference internal" href="markdown_to_rst/test.html">Tests</a></li>
</ul>
</div>
</div>
Expand All @@ -182,7 +182,7 @@ <h1>About Our QMC Software Community<a class="headerlink" href="#about-our-qmc-s

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="rts_from_readme/QMCSoftware.html" class="btn btn-neutral float-right" title="Quasi-Monte Carlo Community Software" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="markdown_to_rst/QMCSoftware.html" class="btn btn-neutral float-right" title="Quasi-Monte Carlo Community Software" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="index.html" class="btn btn-neutral float-left" title="Qmcpy Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Expand Down

0 comments on commit a6e8359

Please sign in to comment.