dupeguru/hscommon
Virgil Dupras e99e2b18e0 Call sphinx-build from withing Python instead of a subprocess 2013-08-19 17:43:32 -04:00
..
.tx Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
docs Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
gui Fixed progress under Cocoa which always cancelled the job 2013-08-04 09:11:19 -04:00
locale Pulled all locs from Transifex 2013-08-03 17:34:02 -04:00
tests Fixed broken tests 2013-08-04 09:26:18 -04:00
.gitignore Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
LICENSE Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
README Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
__init__.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
build.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
conflict.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
currency.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
debug.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
geometry.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
io.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
loc.py Added the --normpo build option 2013-08-03 17:13:24 -04:00
notify.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
path.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
plat.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
pygettext.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
reg.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
sphinxgen.py Call sphinx-build from withing Python instead of a subprocess 2013-08-19 17:43:32 -04:00
sqlite.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
testutil.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00
trans.py Added the Vietnamese language 2013-08-03 17:36:53 -04:00
util.py Added hscommon repo as a subtree 2013-06-22 21:32:23 -04:00

README

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