You have won a FREE new documentation website!

[gradha]

Congratulations!!!

The GitHub(notreally) team has awarded you with the needed website of the week. If you want to win a lot of FAME and rock EVERYWHERE you go, please follow these steps to claim your new and FREE documentation website:

• Install gh_nimrod_doc_pages typing babel install gh_nimrod_doc_pages.
• $ cd path/to/your/git/checkout
• $ git checkout --orphan gh-pages
• $ git rm -rf .
• $ gh_nimrod_doc_pages -b
• Modify the gh_nimrod_doc_pages.ini file to contain the following lines:

["gh-pages"]
update_html=index.html
doc_dir=docs
branches="""
master
"""

• $ gh_nimrod_doc_pages -c .
• $ git add . && git commit -v
• $ git push --set-upstream origin gh-pages

Enjoy your new FREE website for your project!!!

Disclaimers:

• FREE website offer valid only until stocks last.
• AWESOME prize instructions only verified under MacOSX.

[blamestross]

So is this your way of suggesting I make documentation into a project page?

[gradha]

Not necessarily, I'm just promoting the stuff I wrote.

Your readme already mentions the important stuff. It may be nicer for users to have this information as embedded docstrings which in the far away future IDEs could display inline with autocompletion. But it requires you using rst syntax instead of md and rewriting it as bits, rather than a whole module block intro.

However the generated index might be desirable for users to get a look at all that can be done without having to dig the source.