Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.35 KB

README.md

File metadata and controls

38 lines (22 loc) · 1.35 KB

Hangfire Documentation

This repository contains Sphinx-based documentation for Hangfire. https://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!

Contributing via Documentation Site

Documentation is 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.

Building

Clone the repository and run the following command:

make html

After building, generated *.html files will be available in the _build directory.

License

Creative Commons License

This work is licensed under a Creative Commons Attribution 4.0 International License.