Skip to content

Commit

Permalink
Added a note about citations to the readme and the docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoshKarpel
JoshKarpel committed Feb 2, 2018
1 parent a52d503 commit 7403315
Show file tree
Hide file tree
Showing 17 changed files with 872 additions and 818 deletions.
2 changes: 2 additions & 0 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ We recommend installing into a `virtual environment <https://docs.python.org/3/t

Full documentation can be found `here <https://joshkarpel.github.io/idesolver/build/html/index.html>`_.

If you use IDESolver in your work, please consider `citing it <https://doi.org/10.21105/joss.00542>`_.

Details about running the test suite are at the end of the `manual <https://joshkarpel.github.io/idesolver/build/html/manual.html>`_.
Problems with IDESolver should be reported via `GitHub issues <https://github.com/JoshKarpel/idesolver/issues>`_.
We are open to improvements: see the `Code of Conduct <https://github.com/JoshKarpel/idesolver/blob/master/CODE_OF_CONDUCT.md>`_ and the `Contribution Guidelines <https://github.com/JoshKarpel/idesolver/blob/master/CONTRIBUTING.md>`_ for details.
Binary file modified docs/build/html/_images/quickstart_error.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
144 changes: 72 additions & 72 deletions docs/build/html/_modules/idesolver/idesolver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,72 +5,72 @@
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>idesolver.idesolver &mdash; idesolver 1.0.2 documentation</title>


<title>idesolver.idesolver &mdash; idesolver 1.0.2 documentation</title>




























<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />








<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="idesolver 1.0.2 documentation" href="../../index.html"/>
<link rel="up" title="Module code" href="../index.html"/>

<link rel="up" title="Module code" href="../index.html"/>


<script src="../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">


<div class="wy-grid-for-nav">


<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">





<a href="../../index.html" class="icon icon-home"> idesolver





</a>




<div class="version">
1.0.2
1.0.2
</div>







<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
Expand All @@ -79,16 +79,16 @@
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<ul>
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">Quickstart</a></li>
Expand All @@ -98,27 +98,27 @@
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Change Log</a></li>
</ul>



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">idesolver</a>

</nav>



<div class="wy-nav-content">
<div class="rst-content">




Expand All @@ -137,28 +137,28 @@
<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="../../index.html">Docs</a> &raquo;</li>

<li><a href="../index.html">Module code</a> &raquo;</li>

<li>idesolver.idesolver</li>


<li class="wy-breadcrumbs-aside">



</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for idesolver.idesolver</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">A general purpose integro-differential equation (IDE) solver.</span>
Expand Down Expand Up @@ -540,11 +540,11 @@ <h1>Source code for idesolver.idesolver</h1><div class="highlight"><pre>

</div>
<div class="articleComments">

</div>
</div>
<footer>


<hr/>

Expand All @@ -554,7 +554,7 @@ <h1>Source code for idesolver.idesolver</h1><div class="highlight"><pre>

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

Expand All @@ -564,15 +564,15 @@ <h1>Source code for idesolver.idesolver</h1><div class="highlight"><pre>
</section>

</div>







<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION: '1.0.2',
VERSION:'1.0.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
Expand All @@ -584,21 +584,21 @@ <h1>Source code for idesolver.idesolver</h1><div class="highlight"><pre>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>








<script type="text/javascript" src="../../_static/js/theme.js"></script>







<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>


</body>
</html>
</html>

0 comments on commit 7403315

Please sign in to comment.