You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ta...@apache.org on 2022/05/19 16:22:14 UTC

[qpid-proton-dotnet] branch main updated: PROTON-2548 Add a docs build target to the build script

This is an automated email from the ASF dual-hosted git repository.

tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton-dotnet.git


The following commit(s) were added to refs/heads/main by this push:
     new 5180be1  PROTON-2548 Add a docs build target to the build script
5180be1 is described below

commit 5180be1fe96e3ef8486c68976f9a343906ec22ef
Author: Timothy Bish <ta...@gmail.com>
AuthorDate: Thu May 19 12:21:45 2022 -0400

    PROTON-2548 Add a docs build target to the build script
---
 build.sh | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/build.sh b/build.sh
index 9ad0c6f..0f58ed5 100755
--- a/build.sh
+++ b/build.sh
@@ -23,7 +23,7 @@ cd "${0%/*}"
 VERSION=$(<VERSION.txt)
 
 usage() {
-  echo "Usage: $0 {test|dist|sign|clean|docker-test|rat}"
+  echo "Usage: $0 {test|docs|dist|sign|clean|docker-test|rat}"
   exit 1
 }
 
@@ -47,6 +47,22 @@ do
       mvn apache-rat:check -pl :qpid-proton-dotnet
       ;;
 
+    docs)
+      # builds the docs for publication
+
+      if [[ -z "${DOCS_OUTPUT_DIR}" ]]; then
+         mkdir -p dist
+         DOC_DIR=dist/qpid-proton-dotnet-docs-$VERSION
+         rm -rf ${DOC_DIR}
+      else
+         DOC_DIR=${DOCS_OUTPUT_DIR}
+      fi
+
+      # build documentation
+      (env DOXYGEN_OUTPUT_PATH=${DOC_DIR} doxygen Proton.dox)
+      echo "Wrote documentation to directory: $DOC_DIR"
+      ;;
+
     dist)
       # build source tarball for upload to apache dist staging
       mkdir -p dist


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org