Finished dissolving the sphinx source directory into doc/ and doc/scripts/

doc/CMakeLists.txt

@@ -1,8 +1,8 @@
 set(BIF_SRC_DIR ${PROJECT_SOURCE_DIR}/src)
 set(RST_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/rest_output)
 set(DOC_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/out)
-set(DOC_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/source)
+set(DOC_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
-set(DOC_SOURCE_WORKDIR ${CMAKE_CURRENT_BINARY_DIR}/source)
+set(DOC_SOURCE_WORKDIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx-sources)
 
 set(MASTER_POLICY_INDEX ${CMAKE_CURRENT_BINARY_DIR}/scripts/policy_index)
 set(MASTER_PACKAGE_INDEX ${CMAKE_CURRENT_BINARY_DIR}/scripts/pkg_index)
@@ -34,12 +34,12 @@ add_custom_target(broxygen
                           ${DOC_SOURCE_WORKDIR}/scripts/index.rst
                   # append to the master index of all policy packages
                   COMMAND cat ${MASTER_PACKAGE_INDEX} >>
-                          ${DOC_SOURCE_WORKDIR}/packages.rst
+                          ${DOC_SOURCE_WORKDIR}/scripts/packages.rst
                   # construct a reST file for each group
                   COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bin/group_index_generator.py
                           ${CMAKE_CURRENT_BINARY_DIR}/scripts/group_list
                           ${CMAKE_CURRENT_BINARY_DIR}/scripts
-                          ${DOC_SOURCE_WORKDIR}
+                          ${DOC_SOURCE_WORKDIR}/scripts
                   # tell sphinx to generate html
                   COMMAND sphinx-build
                           -b html

doc/conf.py.in

@@ -15,7 +15,7 @@ import sys, os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('source/ext'))
+sys.path.insert(0, os.path.abspath('sphinx-sources/ext'))
 
 # -- General configuration -----------------------------------------------------
 
@@ -27,7 +27,7 @@ sys.path.insert(0, os.path.abspath('source/ext'))
 extensions = ['bro']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['source/_templates', 'source/_static']
+templates_path = ['sphinx-sources/_templates', 'sphinx-sources/_static']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -143,7 +143,7 @@ html_theme_options = {
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['source/_static']
+html_static_path = ['sphinx-sources/_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

doc/index.rst

@@ -1,50 +1,57 @@
-
+.. Bro documentation master file
 
 Bro Documentation
 =================
 
-`Getting Started <{{git('bro:doc/quickstart.rst')}}>`_
+.. toctree::
-    A quick introduction into using Bro 2.x.
+   :maxdepth: 1
 
-`Bro 1.5 to 2.0 Upgrade Guide <{{git('bro:doc/upgrade.rst')}}>`_
+   quickstart
-    Guidelines and notes about upgrading from Bro 1.5 to 2.x. Lots of
+   upgrade
-    things have changed, so make sure to read this when upgrading.
+   FAQ <http://www.bro-ids.org/documentation/faq.html>
-
+   Reporting Problems <http://www.bro-ids.org/documentation/reporting-problems.html>
-`BroControl <{{git('broctl:doc/broctl.rst')}}>`_
-    An interactive console for managing Bro installations.
-
-`Script Reference <{{autodoc_bro_scripts}}/index.html>`_ 
-    A complete reference of all policy scripts shipped with Bro.
-
-`FAQ <{{docroot}}/documentation/faq.html>`_
-    A list with frequently asked questions.
-
-`How to Report a Problem <{{docroot}}/documentation/reporting-problems.html>`_
-    Some advice for when you see Bro doing something you believe it
-    shouldn't.
 
 Frameworks
 ----------
 
-Bro comes with a number of frameworks, some of which are described in
+.. toctree::
-more detail here:
+   :maxdepth: 1
 
-`Notice <{{git('bro:doc/notice.rst')}}>`_
+   notice
-    The notice framework.
+   logging
-
+   cluster
-`Logging <{{git('bro:doc/logging.rst')}}>`_
+   signatures
-    Customizing and extensing Bro's logging.
-
-`Cluster <{{git('bro:doc/cluster.rst')}}>`_
-    Setting up a Bro Cluster when a single box can't handle the traffic anymore.
-        
-`Signatures <{{git('bro:doc/signatures.rst')}}>`_ 
-    Bro has support for traditional NIDS signatures as well.
 
 How-Tos
 -------
 
-We also collect more specific How-Tos on specific topics:
+.. toctree::
+   :maxdepth: 1
 
-`Using GeoIP in Bro scripts <{{git('bro:doc/geoip.rst')}}>`_
+   geoip
-    Installation and usage of the the GeoIP library.
+
+Script Reference
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   scripts/common
+   scripts/builtins
+   scripts/bifs
+   scripts/packages
+   scripts/index
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`search`
+
+Internal References
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   scripts/internal

doc/scripts/CMakeLists.txt

@@ -73,7 +73,7 @@ macro(REST_TARGET srcDir broInput)
     elseif (${extension} STREQUAL ".bif.bro")
         set(group bifs)
     elseif (relDstDir)
-        set(pkgIndex scripts/${relDstDir}/index)
+        set(pkgIndex ${relDstDir}/index)
         set(group ${pkgIndex})
         # add package index to master package list if not already in it
         list(FIND MASTER_PKG_LIST ${pkgIndex} _found)

doc/scripts/bifs.rst

@@ -0,0 +1,5 @@
+.. This is a stub doc to which broxygen appends during the build process
+
+Built-In Functions (BIFs)
+=========================
+

doc/scripts/index.rst

@@ -0,0 +1,8 @@
+.. This is a stub doc to which broxygen appends during the build process
+
+Index of All Bro Scripts
+========================
+
+.. toctree::
+   :maxdepth: 1
+

doc/scripts/internal.rst

@@ -0,0 +1,5 @@
+.. This is a stub doc to which broxygen appends during the build process
+
+Internal Scripts
+================
+

doc/scripts/packages.rst

@@ -1,7 +1,7 @@
-.. This is a stub doc to which the build process can append.
+.. This is a stub doc to which broxygen appends during the build process
 
-Bro Script Packages
+Index of All Bro Script Packages
-===================
+================================
 
 Bro has the following script packages (e.g. collections of related scripts in
 a common directory).  If the package directory contains a ``__load__.bro``

doc/source/bifs.rst

@@ -1,5 +0,0 @@
-.. This is a stub doc to which the build process can append.
-
-Built-In Functions (BIFs)
-=========================
-

doc/source/index.rst

@@ -1,23 +0,0 @@
-.. Bro documentation master file
-
-Welcome to Bro's documentation!
-===============================
-
-Contents:
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   common
-   builtins
-   internal
-   bifs
-   packages
-   scripts/index
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`

doc/source/internal.rst

@@ -1,5 +0,0 @@
-.. This is a stub doc to which the build process can append.
-
-Internal Scripts
-================
-

doc/source/scripts/index.rst

@@ -1,6 +0,0 @@
-Index of All Bro Script Documentation
-=====================================
-
-.. toctree::
-   :maxdepth: 1
-