Hangfire Documentation
This repository contains Sphinx-based documentation for Hangfire. http://docs.hangfire.io
Contributing
The Easy Way
Just click the Edit on GitHub button while observing a page with mistakes as shown below. GitHub will guide you to fork the repository. Please don't forget to create a pull request!
Documentation is being automatically deployed to the site after each commit. For small changes just propose a pull request. Thanks to Read the Docs service for help!
The Hard Way
Installing Sphinx
Official installation guide describes all steps required to run Sphinx on Windows / Linux / Mac OS X.
Installing theme package
Documentation is being hosted on http://readthedocs.org site and uses its theme. So, you should install it first:
pip install sphinx_rtd_theme
Building
Clone the repository and run the following command:
make html
After building, generated *.html files will be available in the _build directory.
License
This work is licensed under a Creative Commons Attribution 4.0 International License.