This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-superset.git
The following commit(s) were added to refs/heads/master by this push:
new 232a5c3 [docs] document how to compile/publish docs (#3296)
232a5c3 is described below
commit 232a5c392e6751a2b5971db3d5bb2ba32bb2ae71
Author: Maxime Beauchemin <maximebeauche...@gmail.com>
AuthorDate: Tue Aug 15 16:37:40 2017 -0700
[docs] document how to compile/publish docs (#3296)
---
CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 27c70dd..012c14c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -380,3 +380,33 @@ to take effect, they need to be compiled using this
command:
Here's an example as a Github PR with comments that describe what the
different sections of the code do:
https://github.com/apache/incubator-superset/pull/3013
+
+## Refresh documentation website
+
+ Every once in a while we want to compile the documentation and publish it.
+ Here's how to do it.
+
+ .. code::
+
+ # install doc dependencies
+ pip install -r dev-reqs-for-docs.txt
+
+ # build the docs
+ python setup.py build_sphinx
+
+ # copy html files to temp folder
+ cp -r docs/_build/html/ /tmp/tmp_superset_docs/
+
+ # clone the docs repo
+ cd ~/
+ git clone
https://git-wip-us.apache.org/repos/asf/incubator-superset-site.git
+
+ # copy
+ cp -r /tmp/tmp_superset_docs/ ~/incubator-superset-site.git/
+
+ # commit and push to `asf-site` branch
+ cd ~/incubator-superset-site.git/
+ git checkout asf-site
+ git add .
+ git commit -a -m "New doc version"
+ git push origin master
--
To stop receiving notification emails like this one, please contact
['"comm...@superset.apache.org" <comm...@superset.apache.org>'].
