This is the site documentation for the Apache Mynewt project. It is built using MkDocs.
This repo previously contained all documentation relating to Apache Mynewt. The
project documentation now resides in the
mynewt-documentation repo.
Code specific documentation is found in various mynewt-* code specific repos.
Archived versions of the project documentation for releases 1.3.0 and earlier
are found under versions
.
Clone the repo:
git clone https://github.com/apache/mynewt-site
cd 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
master
branch.mkdocs serve
NOTE: These instructions assume that your workspace has all the mynewt repos cloned under the same parent directory.
git clone https://github.com/apache/mynewt-documentation
git clone https://github.com/apache/mynewt-core
git clone https://github.com/apache/mynewt-nimble
git clone https://github.com/apache/mynewt-newt
git clone https://github.com/apache/mynewt-newtmgr
Most steps for releasing docs happen at the mynewt-documentation repo. Follow the instructions there first.
master
on github.git checkout master
git pull --rebase origin master
to pull the latest merged changes.NOTE: Skip these steps if you are just refreshing the current documentation or site.
mkdocs.yml
to reflect the new version.
master
is the latest
version.custom-theme/choose_doc_version.html
for the new version.docs/documentation.md
for the new version.extras/robots.txt
for the new version so that./build.py
./serve.py
./deploy.sh build
asf-site
branch.The GitHub Actions workflow performs a build whenever the master branch updates.
It opens a Pull Request against the asf-site
branch if there are any changes. It is recommended
that the runtime-bot PRs are used to deploy changes to the site instead of PRs
from individual contributors. The runtime-bot PRs give us repeatable builds
using known versions of the build tools.
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