Repository: incubator-mynewt-site Updated Branches: refs/heads/develop 8dcf97987 -> 47b782124
Use virtualenv/pip for python setup Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/d31f71cb Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/d31f71cb Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/d31f71cb Branch: refs/heads/develop Commit: d31f71cba64d8a373b8385a7eefe838b3bff28b3 Parents: 8dcf979 Author: Fabio Utzig <[email protected]> Authored: Fri Mar 3 10:49:59 2017 -0300 Committer: Fabio Utzig <[email protected]> Committed: Fri Mar 3 10:49:59 2017 -0300 ---------------------------------------------------------------------- .gitignore | 1 + README.md | 21 ++++++++++++++++----- requirements.txt | 4 ++++ 3 files changed, 21 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d31f71cb/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index 68a916b..3422c7d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ site !.editorconfig .* +venv/ http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d31f71cb/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 6351d8c..59f6906 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,20 @@ The Apache MyNewt site is built using [MkDocs](http://www.mkdocs.org/). ## Setup -### For all contributors: -* Install [MkDocs](http://www.mkdocs.org/) on your system. -### Additionally for committers: -* `pip install GitPython` -* `pip install sh` +Clone the repo: + + git clone https://github.com/apache/incubator-mynewt-site + cd incubator-mynewt-site + +Optional: it's a very good idea to use a `virtualenv`: + + virtualenv venv + . venv/bin/activate + +Install the requirements: + + pip install -r requirements.txt ## Submitting updates @@ -21,6 +29,7 @@ The Apache MyNewt site is built using [MkDocs](http://www.mkdocs.org/). When a new release of MyNewt OS and its associated tools occurs, the documentation in the git `develop` branch of this repository should be in sync with the released version. The following steps will create a documentation branch for the release and make it available as the default documentation from the mynewt-site. ### Build + 1. Merge `develop` to `master`. 1. Switch to the master branch. * `git checkout master` @@ -32,10 +41,12 @@ When a new release of MyNewt OS and its associated tools occurs, the documentati 1. Run: `./build.py` ### Test + 1. Run: `./serve.py` 1. Visit [http://localhost:8000](http://localhost:8000) ### Deploy + 1. Run: `./deploy.sh` 1. This will leave you on the `asf-site` branch. 1. Commit & push the changes. http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d31f71cb/requirements.txt ---------------------------------------------------------------------- diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d46f0b7 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +click +GitPython +mkdocs +sh
