Skip to content

Commit

Permalink
Added releasing.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
r-barnes committed Jan 3, 2018
1 parent 66e8cf9 commit c7214bc
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,9 @@ RichDEM --- High-Performance Terrain Analysis
publications
sponsors
feedback

.. toctree::
:caption: For Developers
:maxdepth: 1

releasing
40 changes: 40 additions & 0 deletions docs/releasing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Release Steps
==================================================

Updating Documentation
--------------------------------------------------

1. Enter the `docs` directory.

2. Run `make html`

3. Enter the `docs/richdem-docs` directory. Commit changes.

4. Go back to the `docs` directory. Commit changes.

5. Push.

6. This will trigger a ReadTheDocs build and a Travis build.


Updating Wheels
--------------------------------------------------

Acquire the manylinux build image with:

docker pull quay.io/pypa/manylinux1_x86_64

Start the docker manylinux build image with:

docker run -i -t e0e55980c200 /bin/bash

You can list running images with:

docker ps

From within the container run the `travis/build-wheels.sh` script to generate
documentation.

From without the container run, e.g.:

docker cp mystifying_darwin:/io/wheelhouse/richdem-0.0.9-cp27-cp27m-linux_x86_64.whl ./

0 comments on commit c7214bc

Please sign in to comment.