Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MAINT: docs maintenance (WIP) #740

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

MAINT: docs maintenance (WIP) #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86794e9
fix theme for sphinx-rtd-theme
mmcky Nov 2, 2024
ace1354
MAINT: work on docs and migrate info from org site
mmcky Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 2 additions & 0 deletions docs/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Developers
==========
2 changes: 2 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
46 changes: 46 additions & 0 deletions docs/source/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)](/).
Loading