mirror of
https://github.com/aljazceru/recon-pipeline.git
synced 2025-12-18 23:04:21 +01:00
5e4d71d32a
* initial work on sphinx docs; much left to do * first pass at docs complete; still has some warts
42 lines
773 B
ReStructuredText
42 lines
773 B
ReStructuredText
==============
|
|
recon-pipeline
|
|
==============
|
|
|
|
``recon-pipeline`` was designed to chain together multiple security tools as part of a Flow-Based Programming paradigm.
|
|
Each component is part of a network of "black box" processes. These components exchange data between each other and
|
|
can be reconnected in different ways to form different applications without any internal changes.
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
.. include:: overview/summary.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
overview/index
|
|
|
|
Changing the Code
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
modifications/index
|
|
|
|
API Reference
|
|
=============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
api/index
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|