CONTRIBUTING.md

Contributing to fathon

If you have found bugs, or you want to propose a new feature:

1. describe the problem and specify the details of your setup (OS, Python version, environment, etc.);
2. provide a minimal working example that can be easily reproduced and tested;
3. open an issue with the previous information in the GitHub repository with tag bug or proposed feature.

PRs are also welcomed.

For any other question, open an issue with tag question.

Documentation

Documentation is written in reStructuredText, built with sphinx and placed in the docs folder.

The script docs_gen.sh generates .py files with only docstrings, since sphinx does not support Cython.

The variable SPHINXBUILD in the Makefile depends on the particular user's system and should be probably changed.

For any problem with the documentation, open an issue with tag documentation.