qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject qpid-dispatch git commit: NO-JIRA: Fix errors in doc generation.
Date Wed, 27 Apr 2016 19:14:56 GMT
Repository: qpid-dispatch
Updated Branches:
  refs/heads/master 0441ea300 -> f76466a05


NO-JIRA: Fix errors in doc generation.


Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/f76466a0
Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/f76466a0
Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/f76466a0

Branch: refs/heads/master
Commit: f76466a0547426bee75507ec9693c07a49cb80bb
Parents: 0441ea3
Author: Alan Conway <aconway@redhat.com>
Authored: Wed Apr 27 15:11:23 2016 -0400
Committer: Alan Conway <aconway@redhat.com>
Committed: Wed Apr 27 15:14:44 2016 -0400

----------------------------------------------------------------------
 doc/CMakeLists.txt                |  6 ++-
 doc/book/CMakeLists.txt           | 67 ----------------------------------
 doc/book/console_installation.rst |  4 +-
 3 files changed, 7 insertions(+), 70 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f76466a0/doc/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 9b683d9..e6fcd52 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -79,8 +79,8 @@ if(BUILD_DOCS)
   # Copy the images. Don't use configure_file since it truncates .png files at 1st ^Z character
   file(GLOB_RECURSE PNG_SRC RELATIVE ${src} *.png)
   foreach(file ${PNG_SRC})
-    #message("${scr}/${file} getting copied to ${bin}/dochtml/${file}.")
-    EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${src}/${file} ${bin}/dochtml/${file})
+    EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${src}/${file} ${bin})
+    EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different ${src}/${file} ${bin}/dochtml)
   endforeach()
 
   # Generate files from management schema
@@ -138,6 +138,8 @@ if(BUILD_DOCS)
       COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b html ${bin} ${bin}/dochtml
       # man/ contains Unix man pages.
       COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b man  ${bin} ${bin}/man
+      # singlehtml is a single HTML page
+      COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b singlehtml ${bin} ${bin}/singlehtml
       DEPENDS ${RST_SRC} ${HELP_GEN} ${SCHEMA_GEN}
       )
     add_custom_target(doc-sphinx DEPENDS ${SPHINX_OUTPUT})

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f76466a0/doc/book/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/doc/book/CMakeLists.txt b/doc/book/CMakeLists.txt
deleted file mode 100644
index bc5d394..0000000
--- a/doc/book/CMakeLists.txt
+++ /dev/null
@@ -1,67 +0,0 @@
-##
-## Licensed to the Apache Software Foundation (ASF) under one
-## or more contributor license agreements.  See the NOTICE file
-## distributed with this work for additional information
-## regarding copyright ownership.  The ASF licenses this file
-## to you under the Apache License, Version 2.0 (the
-## "License"); you may not use this file except in compliance
-## with the License.  You may obtain a copy of the License at
-##
-##   http://www.apache.org/licenses/LICENSE-2.0
-##
-## Unless required by applicable law or agreed to in writing,
-## software distributed under the License is distributed on an
-## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-## KIND, either express or implied.  See the License for the
-## specific language governing permissions and limitations
-## under the License.
-##
-
-# The dipatch book is written in markdown, this generates a HTML version.
-# Requires pandoc, available on yum-based systems as pandoc.
-
-set(src ${CMAKE_CURRENT_SOURCE_DIR})
-set(bin ${CMAKE_CURRENT_BINARY_DIR})
-
-# Generate the schema chapter of the book.
-set(schema, "${CMAKE_SOURCE_DIR}/python/qpid_router/management/qdrouterd.json")
-set(py_management ${CMAKE_SOURCE_DIR}/python/qpid_dispatch_internal/management)
-
-add_custom_command(
-  OUTPUT schema.md
-  COMMAND ${RUN} -s ${src}/schema_md.py 1> schema.md
-  DEPENDS ${py_management}/schema_doc.py ${py_management}/schema.py ${schema} ${src}/schema_md.py
${schema})
-
-set(BOOK ${src}/introduction.md ${src}/using.md ${src}/addressing.md ${src}/amqp-mapping.md
${bin}/schema.md)
-
-# Install markdown documentation in the doc directory.
-install_doc(FILES ${BOOK} DESTINATION ${QD_DOC_INSTALL_DIR})
-
-if(USE_PANDOC)
-  set(PD_ARGS --standalone --toc --number-sections -f markdown -V "title=Qpid Dispatch Router
Book")
-
-  # Generate a book with the given suffix. Extra arguments are passed to pandoc
-  macro(generate_book SUFFIX)
-    set(OUTPUT ${bin}/book${SUFFIX})
-    add_custom_command(
-      OUTPUT ${OUTPUT}
-      COMMAND ${PANDOC} ${PD_ARGS} -o ${OUTPUT} ${ARGN} ${BOOK}
-      DEPENDS man ${BOOK}
-    )
-    install_doc(FILES ${OUTPUT} DESTINATION ${QD_DOC_INSTALL_DIR})
-    set(BOOKS ${BOOKS} ${OUTPUT})
-  endmacro()
-
-  generate_book(.html)          # Complete HTML document.
-  generate_book(.html.in --template ${src}/site-html.pd) # Headless fragment for Qpid website.
-
-  if (USE_PDFLATEX)
-    generate_book(.pdf)      # Complete PDF document.
-  endif(USE_PDFLATEX)
-
-endif(USE_PANDOC)
-
-# Target to generate all chapters and books.
-add_custom_target(book DEPENDS ${BOOK} ${BOOKS})
-add_dependencies(book man) # Note: adding man to book DEPENDS does not work on cmake 2.6.4
-add_dependencies(doc book) # Note: adding man to book DEPENDS does not work on cmake 2.6.4

http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f76466a0/doc/book/console_installation.rst
----------------------------------------------------------------------
diff --git a/doc/book/console_installation.rst b/doc/book/console_installation.rst
index 67ab4ef..52a7332 100644
--- a/doc/book/console_installation.rst
+++ b/doc/book/console_installation.rst
@@ -29,11 +29,13 @@ The following need to be installed before running a console:
 
 A nodejs proxy is distributed with proton.
 To start the proton's nodejs proxy::
-   cd ~/rh-qpid-proton/examples/javascript/messenger
+
+  cd ~/rh-qpid-proton/examples/javascript/messenger
    node proxy.js &
 
 This will start the proxy listening to ws traffic on port 5673 and translating it to tcp
on port 5672.
 One of the routers in the network needs to have a listener configured on port 5672. That
listener's role should be 'normal'. For example::
+
    listener {
       addr: 0.0.0.0
       role: normal


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


Mime
View raw message