qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject svn commit: r1674102 - in /qpid/dispatch/trunk/doc: CMakeLists.txt book/introduction.rst conf.py.in index.rst templates/layout.html themes/ themes/bare/ themes/bare/layout.html themes/bare/theme.conf
Date Thu, 16 Apr 2015 16:06:27 GMT
Author: aconway
Date: Thu Apr 16 16:06:27 2015
New Revision: 1674102

URL: http://svn.apache.org/r1674102
Log:
NO-JIRA: Fix up HTML generation to produce "bare" HTML for qpid site and nice HTML for installed
doc.

Qpid site requires very "bare" HTML - just content, no html, head or body tags.
This checkin creates a very simple "theme" that generates that.

We generate the nice sphinx theme in dochtml for installed documentation, which has search
etc.

Added:
    qpid/dispatch/trunk/doc/themes/
    qpid/dispatch/trunk/doc/themes/bare/
    qpid/dispatch/trunk/doc/themes/bare/layout.html
    qpid/dispatch/trunk/doc/themes/bare/theme.conf
Removed:
    qpid/dispatch/trunk/doc/templates/layout.html
Modified:
    qpid/dispatch/trunk/doc/CMakeLists.txt
    qpid/dispatch/trunk/doc/book/introduction.rst
    qpid/dispatch/trunk/doc/conf.py.in
    qpid/dispatch/trunk/doc/index.rst

Modified: qpid/dispatch/trunk/doc/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/CMakeLists.txt?rev=1674102&r1=1674101&r2=1674102&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/CMakeLists.txt Thu Apr 16 16:06:27 2015
@@ -121,10 +121,11 @@ if(BUILD_DOCS)
 
     set(SPHINX_OUTPUT ${bin}/html/index.html ${bin}/singlehtml/book/book.html ${MAN_PAGES})
 
+    set(html_raw_options -D html_theme=bare -D html_add_permalinks=".")
     add_custom_command(
       OUTPUT ${SPHINX_OUTPUT}
       # html/ contains plain HTML suitable for embedding in the Qpid website.
-      COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b html -D html_theme=basic ${bin} ${bin}/html
+      COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b html ${html_raw_options} ${bin} ${bin}/html
       # dochtml/ is a self-contained site with searching, navigation etc. installed with
the docs.
       COMMAND ${SPHINX_BUILD} -d ${bin}/doctrees -b html ${bin} ${bin}/dochtml
       # man/ contains Unix man pages.

Modified: qpid/dispatch/trunk/doc/book/introduction.rst
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/book/introduction.rst?rev=1674102&r1=1674101&r2=1674102&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/book/introduction.rst (original)
+++ qpid/dispatch/trunk/doc/book/introduction.rst Thu Apr 16 16:06:27 2015
@@ -110,8 +110,8 @@ Simplifies reliability
 Features
 --------
 
--  Can be deployed stand-alone or in a network of routers
-  -  Supports arbitrary network topology - no restrictions on redundancy
-  -  Automatic route computation - adjusts quickly to changes in topology
--  Provides remote access to brokers or other AMQP servers
--  Security
+- Can be deployed stand-alone or in a network of routers
+  - Supports arbitrary network topology - no restrictions on redundancy
+  - Automatic route computation - adjusts quickly to changes in topology
+- Provides remote access to brokers or other AMQP servers
+- Security

Modified: qpid/dispatch/trunk/doc/conf.py.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/conf.py.in?rev=1674102&r1=1674101&r2=1674102&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/conf.py.in (original)
+++ qpid/dispatch/trunk/doc/conf.py.in Thu Apr 16 16:06:27 2015
@@ -20,7 +20,7 @@ release = version
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["**/*_help.rst"]
+exclude_patterns = ["**/*_help.rst", "notes"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -30,6 +30,7 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'sphinxdoc'
+html_theme_path = [ '${CMAKE_CURRENT_SOURCE_DIR}/themes' ]
 html_show_sourcelink = False
 
 # -- Options for manual page output --------------------------------------------

Modified: qpid/dispatch/trunk/doc/index.rst
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/index.rst?rev=1674102&r1=1674101&r2=1674102&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/index.rst (original)
+++ qpid/dispatch/trunk/doc/index.rst Thu Apr 16 16:06:27 2015
@@ -18,17 +18,22 @@
 Documentation for dispatch
 ==========================
 
-See also the `dispatch router website <http://qpid.apache.org/components/dispatch-router>`_
-
 Documentation
 
--  `Dispatch router book <book/book.html>`__
+.. toctree::
+   :maxdepth: 1
+
+   book/book
 
 Manual pages
 
--  `qdrouterd <man/qdrouterd.html>`__ The router daemon
--  `qdrouterd.conf <man/qdrouterd.conf.html>`__ Router daemon
-   configuration
--  `qdstat <man/qdstat.html>`__ Check statistics for a running router
--  `qdmanage <man/qdmanage.html>`__ Query and set management attributes of
-   a running router.
+.. toctree::
+   :maxdepth: 1
+
+   man/qdrouterd
+   man/qdrouterd.conf.rst
+   man/qdstat.rst
+   man/qdmanage.rst
+
+See also the `dispatch router website <http://qpid.apache.org/components/dispatch-router>`_
+

Added: qpid/dispatch/trunk/doc/themes/bare/layout.html
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/themes/bare/layout.html?rev=1674102&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/themes/bare/layout.html (added)
+++ qpid/dispatch/trunk/doc/themes/bare/layout.html Thu Apr 16 16:06:27 2015
@@ -0,0 +1,15 @@
+{#
+    basic/layout.html
+    ~~~~~~~~~~~~~~~~~
+
+    Generate HTML for the Qpid site - just bare content with no html, head or body tags.
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+
+{%- block content %}
+  {%- block document %}
+  {% block body %} {% endblock %}
+  {%- endblock %}
+{%- endblock %}

Added: qpid/dispatch/trunk/doc/themes/bare/theme.conf
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/themes/bare/theme.conf?rev=1674102&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/themes/bare/theme.conf (added)
+++ qpid/dispatch/trunk/doc/themes/bare/theme.conf Thu Apr 16 16:06:27 2015
@@ -0,0 +1,8 @@
+# This theme outputs just bare content with no <html> <head> or <body>
tags.
+# This is the form required by the Qpid website, which will add in its own stylesheets,
+# navigation etc.
+#
+[theme]
+inherit = basic
+
+



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


Mime
View raw message