Repository: qpid-dispatch Updated Branches: refs/heads/master dd83b5ce0 -> 27629e177 (forced update)
DISPATCH-399: Generate body-only HTML documentation for Qpid site. Also added cmake variable to enable verbose output from doc tools for debugging. Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/27629e17 Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/27629e17 Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/27629e17 Branch: refs/heads/master Commit: 27629e177e52fb2eec0b37e22b30b9e8b8ae0378 Parents: da6688a Author: Alan Conway <[email protected]> Authored: Thu Jun 30 15:19:16 2016 -0400 Committer: Alan Conway <[email protected]> Committed: Thu Jun 30 16:50:47 2016 -0400 ---------------------------------------------------------------------- doc/CMakeLists.txt | 19 +++++++++++++------ doc/book/book.adoc | 2 ++ 2 files changed, 15 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/27629e17/doc/CMakeLists.txt ---------------------------------------------------------------------- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index dbe53c6..5505d9c 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -20,6 +20,7 @@ # In old cmake (< 2.8) documentation is built by "make all" so set BUILD_DOC OFF # if you don't want that. For new cmake it is only built by "make doc" option(BUILD_DOCS "Generate documentation with 'make doc'" ON) +option(BUILD_DOCS_VERBOSE "Verbose output from doc tools for debugging" OFF) if(BUILD_DOCS) if ("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}" VERSION_LESS "2.8") @@ -34,6 +35,11 @@ if(BUILD_DOCS) endmacro() endif() + if (BUILD_DOCS_VERBOSE) + set(VFLAG "-v") + endif() + + # Popular locations set(src ${CMAKE_CURRENT_SOURCE_DIR}) set(bin ${CMAKE_CURRENT_BINARY_DIR}) @@ -42,9 +48,6 @@ if(BUILD_DOCS) set(py_management ../python/qpid_dispatch_internal/management) set(schema_depends ${schema} ${py_management}/schema_doc.py ${py_management}/schema.py) - ## Always generate and install the asciidoc .adoc source files as a fallback. - ## They are readable even if we don't have the asciidoc tool to generate HTML. - # Generate asciidoc fragments from management schema to incorporate in text macro(schema_gen script output) add_custom_command( @@ -89,9 +92,13 @@ if(BUILD_DOCS) foreach(source index book/book man/qdmanage.8 man/qdrouterd.8 man/qdstat.8 ${bin}/qdrouterd.conf.5) get_filename_component(name ${source} NAME) set(output ${bin}/${name}.html) + set(ADOC_FLAGS ${VFLAG} --conf-file=${bin}/asciidoc.conf) add_custom_command( - OUTPUT ${output} - COMMAND ${ASCIIDOC_EXE} -b xhtml11 --conf-file=${bin}/asciidoc.conf -o ${output} ${source}.adoc + OUTPUT ${output} ${output}.in + # Pretty .html for direct viewing. + COMMAND ${ASCIIDOC_EXE} ${ADOC_FLAGS} -o ${output} ${source}.adoc + # Raw .html.in body for inclusion in Qpid website. + COMMAND ${ASCIIDOC_EXE} ${ADOC_FLAGS} -s -o ${output}.in ${source}.adoc DEPENDS ${source}.adoc ${GENERATED_TXT} ${ADOC_SRC} ${bin}/asciidoc.conf WORKING_DIRECTORY ${src} # Book include links assume we are in source dir. ) @@ -101,7 +108,7 @@ if(BUILD_DOCS) find_program(A2X_EXE a2x DOC DOC "Generate Unix man pages") if (A2X_EXE) - set(A2X_FLAGS --asciidoc-opts=--conf-file=${bin}/asciidoc.conf --asciidoc-opts=-v -D ${bin}) + set(A2X_FLAGS ${VFLAG} --asciidoc-opts=--conf-file=${bin}/asciidoc.conf -D ${bin}) # Generate man pages. foreach(source ${src}/man/qdmanage.8 ${src}/man/qdrouterd.8 ${src}/man/qdstat.8 ${bin}/qdrouterd.conf.5) http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/27629e17/doc/book/book.adoc ---------------------------------------------------------------------- diff --git a/doc/book/book.adoc b/doc/book/book.adoc index 203c3b1..70aba8e 100644 --- a/doc/book/book.adoc +++ b/doc/book/book.adoc @@ -56,7 +56,9 @@ include::{generated}/schema.adoc[] Console ------- :leveloffset: 1 + include::console_overview.adoc[] include::console_installation.adoc[] include::console_operation.adoc[] + :leveloffset: 0 --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
