The documentation has to be built with Sphinx. You can get Sphinx at http://sphinx.pocoo.org/

Once you installed it, you can build the documentation with:

cd docs sphinx-build . ../docs_html

The reason why you have to move in 'docs' is because hscommon.io conflicts with the builtin 'io' module. The documentation is also available online at http://www.hardcoded.net/docs/hscommon

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.