Hieroglyph uses Buildout to manage dependencies and development.
Check out the repository:
$ git clone firstname.lastname@example.org:nyergler/hieroglyph.git
Bootstrap and run buildout:
$ python bootstrap.py $ ./bin/buildout
After running Buildout, you can run
./bin/python to execute an
interpreter with Hieroglyph and its dependencies installed.
The unit tests can be run via
$ ./bin/python setup.py test
Tox can be used to run the tests with both Python 2 and 3. The Tox configuration will run the tests with Sphinx 1.1.x, Sphinx 1.2.x, and the development branch. Note that Hieroglyph requires Tox 1.8.
There are some Jasmine tests in
src/jstests that test theme
in your browser to run those. Alternately, you can install the
jasmine gem to do so.
If you have Bundler installed, get started by installing the necessary gems:
$ bundle install
Then run the tests using
$ rake jasmine:ci JASMINE_CONFIG_PATH=./src/jstests/jasmine.yml