Skip to content
This repository has been archived by the owner on Mar 12, 2020. It is now read-only.

Commit

Permalink
Add instructions for ghp-import
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Graves committed Nov 5, 2015
1 parent dd085cc commit 5f5af37
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
21 changes: 1 addition & 20 deletions README.md
@@ -1,22 +1,3 @@
# Kepler

## Development

Clone the repo

```
$ git clone git@github.com:MITLibraries/kepler.git
```

Install dependencies

```
$ pip install -r requirements.txt
```

Run tests

```
$ pip install tox
$ tox
```
See the documentation at http://mitlibraries.github.io/kepler/.
8 changes: 7 additions & 1 deletion docs/index.rst
Expand Up @@ -91,7 +91,13 @@ In order to generate the documentation you have to make sure `Sphinx <http://sph
(kepler-docs)$ cd docs
(kepler-docs)$ make html

This will place the built documents in ``kepler/docs/_build/``.
This will place the built documents in ``kepler/docs/_build/``. The built docs can be uploaded to the `project page <http://mitlibraries.github.io/kepler/>`_ using `ghp-import <https://github.com/davisp/ghp-import>`_. It is recommended to install ``ghp-import`` using `pipsi <https://github.com/mitsuhiko/pipsi>`_::

$ pipsi install ghp-import
$ cd /path/to/kepler
$ ghp-import -n docs/_build/html
$ git co gh-pages
$ git push origin gh-pages


Documentation Contents
Expand Down

0 comments on commit 5f5af37

Please sign in to comment.