3b84216652
* Document how to build the doumentation with sphinx
For convinience, I added a Makefile which spares one to memorize the
long sphinx command, or type python setup.py build_sphinx
You simply use `make html` and you will get the docs.
* Render README with markdown properly
conf.py includes some code to work around a bug in
common mark. The markdown is now properly converted to HTML.
* Fix rendering of CONTRIBUTING.md
74 lines
904 B
Plaintext
74 lines
904 B
Plaintext
# Byte-compiled / optimized / DLL files
|
|
__pycache__/
|
|
*.py[cod]
|
|
*$py.class
|
|
|
|
# C extensions
|
|
*.so
|
|
|
|
# Distribution / packaging
|
|
.Python
|
|
env/
|
|
build/
|
|
develop-eggs/
|
|
dist/
|
|
downloads/
|
|
eggs/
|
|
.eggs/
|
|
lib/
|
|
lib64/
|
|
parts/
|
|
sdist/
|
|
var/
|
|
*.egg-info/
|
|
.installed.cfg
|
|
*.egg
|
|
|
|
# PyInstaller
|
|
# Usually these files are written by a python script from a template
|
|
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
*.manifest
|
|
*.spec
|
|
|
|
# Installer logs
|
|
pip-log.txt
|
|
pip-delete-this-directory.txt
|
|
|
|
# Unit test / coverage reports
|
|
htmlcov/
|
|
.tox/
|
|
.coverage
|
|
.coverage.*
|
|
.cache
|
|
nosetests.xml
|
|
coverage.xml
|
|
*,cover
|
|
.hypothesis/
|
|
venv/
|
|
.python-version
|
|
|
|
# Translations
|
|
*.mo
|
|
*.pot
|
|
|
|
# Django stuff:
|
|
*.log
|
|
|
|
# Sphinx documentation
|
|
docs/_build/
|
|
|
|
# PyBuilder
|
|
target/
|
|
|
|
#Ipython Notebook
|
|
.ipynb_checkpoints
|
|
|
|
# Intellij IDEA files
|
|
.idea/*
|
|
*.iml
|
|
.vscode
|
|
|
|
# created by sphinx documentation build
|
|
doc/source/README.md
|
|
doc/_build
|