diff --git a/docs/source/conf.py b/docs/source/conf.py index ca37505d..14e529b9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,6 +70,7 @@ def install(package): # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx_rtd_theme' 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', @@ -155,7 +156,7 @@ def install(package): # -- Options for HTML output ---------------------------------------------- on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if on_rtd: - html_theme = 'default' + html_theme = 'sphinx_rtd_theme' else: # Local build. Need to import rtd theme import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 00000000..dd54e618 --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1,2 @@ +Developers +========== diff --git a/docs/source/index.rst b/docs/source/index.rst index 6dcf2531..78469d9c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,12 +11,14 @@ mainly used by developers internal to the package. .. toctree:: :maxdepth: 2 + setup game_theory markov optimize random tools util + contributing Indices and tables ================== diff --git a/docs/source/setup.rst b/docs/source/setup.rst new file mode 100644 index 00000000..496b6108 --- /dev/null +++ b/docs/source/setup.rst @@ -0,0 +1,46 @@ +Installation +============ + +Before installing `quantecon` we recommend you install the [Anaconda](https://www.anaconda.com/download/) Python distribution, which includes a full suite of scientific python tools. + +Next you can install quantecon by opening a terminal prompt and typing + +.. code:: + pip install quantecon + + +Usage +----- + +Once `quantecon` has been installed you should be able to import it as follows: + + import quantecon as qe + +You can check the version by running + + print(qe.__version__) + +If your version is below what’s available on [PyPI](https://pypi.python.org/pypi/quantecon/) then it is time to upgrade. This can be done by running + + pip install --upgrade quantecon + +Downloading the `quantecon` Repository +-------------------------------------- + +An alternative is to download the sourcecode of the `quantecon` package and install it manually from [the github repository](https://github.com/QuantEcon/QuantEcon.py/). For example, if you have git installed type + + git clone https://github.com/QuantEcon/QuantEcon.py + +Once you have downloaded the source files then the package can be installed by running + + cd QuantEcon.py + pip install ./ + +(To learn the basics about setting up Git see [this link](https://help.github.com/articles/set-up-git/).) + +Examples and Sample Code +------------------------ + +Many examples of QuantEcon.py in action can be found at [Quantitative Economics](https://lectures.quantecon.org/). + +QuantEcon.py is supported financially by the [Alfred P. Sloan Foundation](http://www.sloan.org/) and is part of the [QuantEcon organization (A NumFOCUS fiscally sponsored project)](/). \ No newline at end of file