Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Continuous Documentation #344

Merged
merged 6 commits into from
Oct 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ repository to avoid duplicating work across multiple repositories.
If you find any problems with the test setup and deployment, please create issues and
submit pull requests to that repository.

## Continuous Documentation

We use the [Zeit Now for Github integration](https://zeit.co/github) to preview changes
made to our documentation website every time we make a commit in a pull request.
The integration service has a configuration file `now.json`, with a list of options to
change the default behaviour at https://zeit.co/docs/configuration.
The actual script `package.json` is used by Zeit Now to install the necessary packages,
build the documentation, copy the files to a 'public' folder and deploy that to the web,
see https://zeit.co/docs/v2/build-step/?query=package.json#defining-a-build-script.
weiji14 marked this conversation as resolved.
Show resolved Hide resolved

## Making a Release

Expand Down
6 changes: 6 additions & 0 deletions now.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"github": {
"silent": true
},
"public": true
}
8 changes: 8 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"scripts": {
"build:miniconda": "curl -o ~/miniconda.sh https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh && bash ~/miniconda.sh -b -p $HOME/miniconda",
"build:pygmt": "conda env create -f environment.yml && source activate pygmt && conda install -c conda-forge -c conda-forge/label/dev -y gmt==6.0.0rc4 && make install",
"build:docs": "source activate pygmt && cd doc && make all && mv _build/html ../public",
"build": "export PATH=$HOME/miniconda/bin:$PATH && npm run build:miniconda && npm run build:pygmt && npm run build:docs"
}
}