Improve documentation about schedule HOT 5 CLOSED

Would really appreciate example code for multiple use cases:

• Clear logs every day
• Run task every minute
• Run task every minute without blocking anything
• Run task from a message queue (redis)
• Run in a distributed env
• Handling exceptions the right way

from schedule.

Please do, love this module but documentation so far is very poor.

from schedule.

I think this is still a key thing we should focus on to improve schedule. Bump.

from schedule.

Alright I just merged #108 – docs are live now at https://schedule.readthedocs.io

I'd greatly appreciate some help with fleshing out the docs further. I've laid down some basic structure but haven't migrated the FAQ or continued building it out.

If you're not comfortable with editing the Sphinx docs then improving the docstrings in the code directly would help a lot (https://schedule.readthedocs.io/en/latest/api.html)

Better docs is one of the best things we can do for the project right now.

from schedule.

I want to link some docs-related stuff for future reference:

• http://www.sphinx-doc.org/en/1.4.8/tutorial.html
• https://daler.github.io/sphinxdoc-test/includeme.html
• http://www.sphinx-doc.org/en/1.4.8/ext/autodoc.html

I also haven't updated the dev docs on generating and viewing the Sphinx web docs locally. Basically you need to:

pip install -r requirements-dev.txt
cd docs
make html
cd _build/html
python -m SimpleHTTPServer 8888

and then open http://localhost:8888 in your favorite browser 🌟

from schedule.