diff --git a/.buckconfig b/.buckconfig index 1bc29ac6e4..9017c7eb74 100644 --- a/.buckconfig +++ b/.buckconfig @@ -5,6 +5,7 @@ docs = //Documentation:html gerrit = //:gerrit release = //:release + withdocs = //:withdocs [buildfile] includes = //tools/default.defs diff --git a/Documentation/dev-buck.txt b/Documentation/dev-buck.txt index 1acff3ba42..611d64da40 100644 --- a/Documentation/dev-buck.txt +++ b/Documentation/dev-buck.txt @@ -211,7 +211,7 @@ next time project.py is run: Documentation ~~~~~~~~~~~~~ -To build the documentation: +To build only the documentation: ---- buck build docs @@ -229,6 +229,18 @@ The html files will also be bundled into `html.zip` in this location: buck-out/gen/Documentation/html.zip ---- +To build the executable WAR with the documentation included: + +---- + buck build withdocs +---- + +The WAR file will be placed in: + +---- + buck-out/gen/withdocs.war +---- + [[release]] Gerrit Release WAR File ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Documentation/rest-api-documentation.txt b/Documentation/rest-api-documentation.txt index 0defe6de3f..56e6c9219e 100644 --- a/Documentation/rest-api-documentation.txt +++ b/Documentation/rest-api-documentation.txt @@ -7,9 +7,9 @@ link:rest-api.html[REST API]. Please note that this feature is only usable with documentation built-in. You'll need to -`buck build :withdocs` +`buck build withdocs` or -`buck build :release` +`buck build release` to test this feature. [[documentation-endpoints]]