Skip to content

Commit 9edd92d

Browse files
Added multiversion command to CircleCI and README.
Signed-off-by: Leander Stephen D'Souza <[email protected]>
1 parent 111edc8 commit 9edd92d

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

.circleci/config.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,16 @@ references:
2020
python3-pip \
2121
ttf-dejavu
2222
pip3 install -r requirements.txt
23-
make_docs: &make_docs
23+
make_local_docs: &make_local_docs
2424
run:
25+
name: Build local docs
2526
command: |
2627
make html
28+
make_docs: &make_docs
29+
run:
30+
name: Build multiversion docs
31+
command: |
32+
make clean multiversion
2733
store_docs: &store_docs
2834
store_artifacts:
2935
path: _build/html
@@ -45,6 +51,7 @@ commands:
4551
build_docs:
4652
description: "Build docs"
4753
steps:
54+
- *make_local_docs
4855
- *make_docs
4956
- *store_docs
5057
publish_docs_to_gh_pages_branch:

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ pip3 install -r requirements.txt
3333
### Build the Docs
3434
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.
3535

36+
For building the deployed version of the docs, `make multiversion` will build the documentation for all supported branches of Nav2, ignoring the changes locally.
37+
To include your local changes, make sure to merge locally with the supported branch you want to build against.
38+
3639
Any images, diagrams, or videos are subject to their own copyrights, trademarks, and licenses.
3740

3841
Want a local PDF version? Follow the [instructions here](https://gist.github.com/alfredodeza/7fb5c667addb1c6963b9).

0 commit comments

Comments
 (0)