Skip to content

Commit

Permalink
transfer links to rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcky committed Nov 27, 2024
1 parent 43ab3d1 commit ad35eeb
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Contribute to QuantEcon.py
==========================

If you would like to contribute to `QuantEcon.py`<https://github.com/QuantEcon/QuantEcon.py>,
a good place to start is the `project issue tracker`<http://github.com/QuantEcon/QuantEcon.py/issues>.
If you would like to contribute to :ref:`QuantEcon.py<https://github.com/QuantEcon/QuantEcon.py>`,
a good place to start is the :ref:`project issue tracker<http://github.com/QuantEcon/QuantEcon.py/issues>`.

Set up a Conda development environment
--------------------------------------

One of the advantages of the [Anaconda Python environment](https://www.anaconda.com/distribution/) is that it is
One of the advantages of the :ref:`Anaconda Python environment<https://www.anaconda.com/distribution/>` is that it is
cheap to set up (and discard) Python environments for development versions of packages and populate them with your
favorite scientific tools. For example, if youre working on QuantEcon.py you might find it useful to set up an
favorite scientific tools. For example, if you're working on QuantEcon.py you might find it useful to set up an
environment (containing NumPy, SciPy, etc.) that uses your development version rather than the default ones.

This facilitates contributing to QuantEcon.py without worrying about corrupting the Python environment on which your other work depends.
Expand All @@ -23,7 +23,7 @@ Write documentation
-------------------

We try to maintain a simple and consistent format for inline documentation, known in the Python world as docstrings.
The format we use is known as [numpydoc](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
The format we use is known as :ref:`numpydoc<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`.
It was developed by the numpy and scipy teams and is used in many popular packages.

Adhering to this standard helps us
Expand All @@ -32,13 +32,13 @@ Adhering to this standard helps us

* Give users instant access to necessary information at the interpreter prompt (either via the built-in Python function help(object_name) or the Jupyter object_name?)

* Easily generate a reference manual using sphinxs autodoc and apidoc
* Easily generate a reference manual using sphinx's autodoc and apidoc

Instructions to compile a local version of the documentation can be found [here](https://github.com/QuantEcon/QuantEcon.py/tree/master/docs).
Instructions to compile a local version of the documentation can be found :ref:`here<https://github.com/QuantEcon/QuantEcon.py/tree/master/docs>`.
This can be useful if you would like to check how your docstrings render in html prior to submitting a pull request.

Further questions
-----------------

We encourage you to reach out to the [QuantEcon team](https://quantecon.org/team) on the
[Discourse forum](http://discourse.quantecon.org/) if you have any further questions.
We encourage you to reach out to the :ref:`QuantEcon team<https://quantecon.org/team>` on the
:ref:`Discourse forum<http://discourse.quantecon.org/>` if you have any further questions.

0 comments on commit ad35eeb

Please sign in to comment.