Skip to content

Commit

Permalink
Doc updates to Introduction and sphinx python script
Browse files Browse the repository at this point in the history
  • Loading branch information
@aaron-bray
aaron-bray committed Sep 14, 2017
1 parent 960173e commit 23c9bcf
Show file tree
Hide file tree
Showing 3 changed files with 111 additions and 83 deletions.
9 changes: 5 additions & 4 deletions doc/manuals/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'breathe'
'breathe',
]

# Breathe support - need to make directory name more flexible
breathe_projects = { "kwiver": "../doxygen" }
breathe_default_project = "kwiver"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down Expand Up @@ -366,6 +370,3 @@
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

# Breathe support - need to make directory name more flexible
breathe_projects = { "kwiver": "../doxygen" }
breathe_default_project = "kwiver"
95 changes: 95 additions & 0 deletions doc/manuals/getting_code.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,98 @@ Getting KWIVER

Refer to the `repository <https://github.com/Kitware/kwiver>`_ for getting and building the KWIVER code base

Code Structure and Provided Functionality
-----------------------------------------

Below is a summary of the key directories in KWIVER and a brief summary of the content they contain.


================ ===========================================================
CMake_ CMake helper scripts
arrows_ The algorithm plugin modules
doc_ Documentation, manuals, release notes
examples_ Examples for running KWIVER (currently out of date)
extras_ Extra utilities (e.g. instrumentation)
sprokit_ Stream processing toolkit
tests_ Testing related support code
vital_ Core libraries source and headers
================ ===========================================================

.. _CMake: https://github.com/Kitware/kwiver/tree/master/CMake
.. _arrows: https://github.com/Kitware/kwiver/tree/master/arrows
.. _doc: https://github.com/Kitware/kwiver/tree/master/doc
.. _examples: https://github.com/Kitware/kwiver/tree/master/examples
.. _extras: https://github.com/Kitware/kwiver/tree/master/extras
.. _sprokit: https://github.com/Kitware/kwiver/tree/master/sprokit
.. _tests: https://github.com/Kitware/kwiver/tree/master/tests
.. _vital: https://github.com/Kitware/kwiver/tree/master/vital

Vital
-----

========================= =========================================================
`<vital/algo>`_ Abstract algorithm definitions
`<vital/bindings>`_ C and Python bindings
`<vital/config>`_ Configuration support code
`<vital/exceptions>`_ Exception class hierarchy
`<vital/io>`_ Classes that support reading and writing core data types
`<vital/kwiversys>`_ Code that supports the OS abstraction layer
`<vital/logger>`_ Classes that provide logging support
`<vital/plugin_loader>`_ Classes that provide plugin loading services
`<vital/tests>`_ Unit tests for vital code
`<vital/tools>`_ Source for command line utilities
`<vital/types>`_ Classes for the core data types
`<vital/util>`_ Source for general purpose utility functions
`<vital/video_metadata>`_ Classes that support video metadata
========================= =========================================================

Arrows
------

===================== =========================================================
`<arrows/burnout>`_ [*Experimental*] Pixel classifiers for heads-up display
detection an related tasks using Vibrant_.
`<arrows/ceres>`_ Algorithms for bundle adjustment and optimization using
`Ceres Solver`_.
`<arrows/core>`_ Algorithms implemented with no additional third party
dependencies beyond what Vital uses (Eigen).
`<arrows/darknet>`_ [*Experimental*] Object detection with the Darknet_ YOLO CNN.
`<arrows/matlab>`_ An interface for running Matlab code KWIVER
`<arrows/ocv>`_ Algorithms implemented using OpenCV_.
Includes feature detectors and descriptor, homography
and fundamental matrix estimation, image IO, and more.
`<arrows/proj>`_ Geographic conversion functions implemented with PROJ4_.
`<arrows/uuid>`_ [*Experimental*] Implementation of unique IDs using libuuid
`<arrows/viscl>`_ [*Experimental*] Algorithms using VisCL to implement
algorithms in OpenCL
`<arrows/vxl>`_ Algorithms implemnted using the VXL_ libraries.
Includes bundle adjustment, homography estimation, video
file reading, and more.
===================== =========================================================

Sprokit
-------

====================== =========================================================
`<sprokit/cmake>`_ CMake helper scripts specific to Sprokit
`<sprokit/conf>`_ Configuration files CMake will tailor to the build system
machine and directory structure
`<sprokit/doc>`_ Further documenation related to sprokit
`<sprokit/extra>`_ General scripts, hooks, and cofigurations for use with 3rd
party tools (e.g. git and vim)
`<sprokit/pipelines>`_ Example pipeline files demonstrating the execution of
various arrows through sprokit
`<sprokit/processes>`_ General utility processess that encapsulate various arrows
for core funcionality
`<sprokit/src>`_ Core infrastructure code for defining, chaining, and
executing Sprokit processes
`<sprokit/tests>`_ Sprokit unit tests
====================== =========================================================


.. _`Ceres Solver`: http://ceres-solver.org/
.. _Vibrant: https://github.com/Kitware/vibrant
.. _Darknet: https://pjreddie.com/darknet/yolo/
.. _OpenCV: http://opencv.org/
.. _PROJ4: http://proj4.org/
.. _VXL: https://github.com/vxl/vxl/
90 changes: 11 additions & 79 deletions doc/manuals/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,83 +70,15 @@ Sprokit schedules the jobs to run each process and keep data flowing through
pipeline. Sprokit also allows processes written in Python to be
interconnected with those written in C++.

Code Structure and Provided Functionality
=========================================

Below is a summary of the key directories in KWIVER and a brief summary of
the content they contain.


================ ===========================================================
`<CMake>`_ CMake helper scripts
`<arrows>`_ The algorithm plugin modules
`<doc>`_ Documentation, manuals, release notes
`<examples>`_ Examples for running KWIVER (currently out of date)
`<extras>`_ Extra utilities (e.g. instrumentation)
`<sprokit>`_ Stream processing toolkit
`<tests>`_ Testing related support code
`<vital>`_ Core libraries source and headers
================ ===========================================================

Vital
-----

========================= =========================================================
`<vital/algo>`_ Abstract algorithm definitions
`<vital/bindings>`_ C and Python bindings
`<vital/config>`_ Configuration support code
`<vital/exceptions>`_ Exception class hierarchy
`<vital/io>`_ Classes that support reading and writing core data types
`<vital/kwiversys>`_ Code that supports the OS abstraction layer
`<vital/logger>`_ Classes that provide logging support
`<vital/plugin_loader>`_ Classes that provide plugin loading services
`<vital/tests>`_ Unit tests for vital code
`<vital/tools>`_ Source for command line utilities
`<vital/types>`_ Classes for the core data types
`<vital/util>`_ Source for general purpose utility functions
`<vital/video_metadata>`_ Classes that support video metadata
========================= =========================================================

Arrows
------

===================== =========================================================
`<arrows/burnout>`_ [*Experimental*] Pixel classifiers for heads-up display
detection an related tasks using Vibrant_.
`<arrows/ceres>`_ Algorithms for bundle adjustment and optimization using
`Ceres Solver`_.
`<arrows/core>`_ Algorithms implemented with no additional third party
dependencies beyond what Vital uses (Eigen).
`<arrows/darknet>`_ [*Experimental*] Object detection with the Darknet_ YOLO CNN.
`<arrows/matlab>`_ An interface for running Matlab code KWIVER
`<arrows/ocv>`_ Algorithms implemented using OpenCV_.
Includes feature detectors and descriptor, homography
and fundamental matrix estimation, image IO, and more.
`<arrows/proj>`_ Geographic conversion functions implemented with PROJ4_.
`<arrows/uuid>`_ [*Experimental*] Implementation of unique IDs using libuuid
`<arrows/viscl>`_ [*Experimental*] Algorithms using VisCL to implement
algorithms in OpenCL
`<arrows/vxl>`_ Algorithms implemnted using the VXL_ libraries.
Includes bundle adjustment, homography estimation, video
file reading, and more.
===================== =========================================================

Sprokit
-------

====================== =========================================================
`<sprokit/cmake>`_ CMake helper scripts specific to Sprokit
`<sprokit/conf>`_ Configuration files CMake will tailor to the build system
machine and directory structure
`<sprokit/doc>`_ Further documenation related to sprokit
`<sprokit/extra>`_ General scripts, hooks, and cofigurations for use with 3rd
party tools (e.g. git and vim)
`<sprokit/pipelines>`_ Example pipeline files demonstrating the execution of
various arrows through sprokit
`<sprokit/processes>`_ General utility processess that encapsulate various arrows
for core funcionality
`<sprokit/src>`_ Core infrastructure code for defining, chaining, and
executing Sprokit processes
`<sprokit/tests>`_ Sprokit unit tests
====================== =========================================================

.. _Boost: http://www.boost.org/
.. _CDash: http://www.cdash.org/
.. _Eigen: http://eigen.tuxfamily.org/
.. _Fletch: https://github.com/Kitware/fletch
.. _Kitware: http://www.kitware.com/
.. _MAP-Tk: https://github.com/Kitware/maptk
.. _Travis CI: https://travis-ci.org/
.. _VIAME: https://github.com/Kitware/VIAME
.. _`Ceres Solver`: http://ceres-solver.org/
.. _OpenCV: http://opencv.org/
.. _VXL: https://github.com/vxl/vxl/

0 comments on commit 23c9bcf

Please sign in to comment.