commit | b3269d68c4bd06a900f97b0b9cd1811f4c5e6715 | [log] [tgz] |
---|---|---|
author | ccollins476ad <ccollins476ad@gmail.com> | Thu Jul 06 11:18:46 2017 -0700 |
committer | GitHub <noreply@github.com> | Thu Jul 06 11:18:46 2017 -0700 |
tree | fb1b06fd430f70d5f10325814cdcd4fc2e914fad | |
parent | 878be208b68ebcdce3f3a29342cb22de1ac644e7 [diff] | |
parent | a7cd901879002f77ae98f527259ca7dbb0aafedb [diff] |
Merge pull request #225 from spoonofpower/v1_0_0 Add known issues to v1_0_0
The Apache MyNewt site is built using MkDocs.
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
develop
branch.mkdocs serve
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.
develop
to master
.git checkout master
mkdocs.yml
to reflect the new version.latest
flag, only one release should be marked latest../build.py
./serve.py
./deploy.sh
asf-site
branch.For the deployed site a version prefix is added to the URL for each mkdocs page. When developing there is no version prefix. If you want to link from a site page to a documentation page you should prefix the URL with /DOCSLINK/ so that the user is taken to the correct location when browsing in production.
./build.py --test-build
./serve.py