Browse Source

Add a script to push docs to gh-pages

Steven Silvester 5 years ago
parent
commit
4f2f10cfc9
2 changed files with 19 additions and 0 deletions
  1. 5 0
      RELEASE.md
  2. 14 0
      scripts/docs_push.sh

+ 5 - 0
RELEASE.md

@@ -146,6 +146,7 @@ Now do the actual final release:
 - [ ] Push the commit and tags to master
 - [ ] Run `npm run publish:all` to publish the packages
 - [ ] Create a branch for the release and push to GitHub
+- [ ] Update the API [docs](#updating-api-docs)
 - [ ] Merge the PRs on the other repos and set the default branch of the
       xckd repo
 - [ ] Publish to [conda-forge](https://github.com/jupyterlab/jupyterlab/blob/master/RELEASE.md#publishing-to-conda-forge).
@@ -252,6 +253,10 @@ shasum -a 256 dist/*.tar.gz
 - Create a PR with the version bump
 - Update `recipe/meta.yaml` with the new version and md5 and reset the build number to 0.
 
+## Updating API Docs
+
+Run `source scripts/docs_push.sh` to update the `gh-pages` branch that backs http://jupyterlab.github.io/jupyterlab/.
+
 ## Making a patch release
 
 - Backport the change to the previous release branch

+ 14 - 0
scripts/docs_push.sh

@@ -0,0 +1,14 @@
+
+#!/bin/bash
+
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+jlpm
+jlpm build:packages
+jlpm docs
+cd docs/api
+git init
+touch .nojekyll  # disable jekyll
+git add .
+git commit -m "Deploy to GitHub Pages"
+git push --force "https://github.com/jupyterlab/jupyterlab" master:gh-pages