Please report any issues on the GitHub Issue Tracker.
To suggest a change to the code or documentation, please create a new pull request on GitHub. Contributed code must come with an appropriate unit test. Please ensure that your code follows PEP8, by running, for example, flake8 before submitting a pull request. Also, please squash multiple commits into a single commit in your pull request by rebasing onto the master branch.
By contributing to this project, you are agreeing to license your code contributions under both the GNU Affero General Public License, either version 3 or any later version, and the 3-clause BSD License, and your documentation contributions under the Creative Commons Attribution-ShareAlike License version 4.0, as described in the copyright license section above.
Using pip is probably the easiest way to install this:
pip install -r requirements/test.txt
To run the tests:
make check
make package
Flask-Restless requires the following program and supporting library to build the documentation:
- Sphinx
- sphinxcontrib-httpdomain, version 1.1.7 or greater
These requirements are also listed in the requirements-doc.txt file. Using
pip is probably the easiest way to install these:
pip install -r requirements/doc.txt
The documentation is written for Sphinx in reStructuredText files in the
docs/ directory. Documentation for each class and function is provided in the
docstring in the code.
The documentation uses the Flask Sphinx theme. It is included as a git
submodule of this project, rooted at docs/_themes. To get the themes, do
git submodule update --init
Now to build the documentation, run the command
python setup.py build_sphinx
in the top-level directory. The output can be viewed in a web browser by
opening build/sphinx/html/index.html.