README.md

pymtg

Python research utils that some of us use at the MTG and eventually everyone will use :)

You can install this package using pip using the following line:

pip install git+https://github.com/MTG/pymtg

Documentation

Docs are hosted using Github Pages and can be found here https://mtg.github.io/pymtg/.

Docs are built using Sphinx. Use the following commands:

pip install -r requirements_docs.txt
make html

To update the documentation hosted in https://mtg.github.io/pymtg/, docs need to be rebuild locally and newly generated files (under docs/) pushed to the master branch.

Documentation is mainly built by reading docstrings. To have better consistency we recommend to follow the Google Style Python Docstrings, which read well on console and also render well using Sphinx.

We also encourage you to use the Examples section of the docstring to provide usage examples that can also be used as unit tests (using doctest). Have a look at this nice post about Testing through documentation to learn how to use doctest.

All tests embedded in docstrings can be run at once with the command:

python test.py

Adding Tips

First of all you need to have Sphinx installed.

Then you need to go to docs_src/tips and make two different things:

• Create a new file for your tip of the week. These files are written in ReStructured Text, so you just need to format your information into rst.
• Add your tip to the list of tips on the toctree of tips.rst

Once that is done you just need to move to the pymtg folder on your terminal and type the following command make html. This will create the html pages from your rst files.