f3848085e1
This patch changes the format of Stackviz docs so that all information is stored in the appropriate doc/source/ directory rather than all in README.rst. README.rst now just uses the RST include directive to get its text from doc/source/readme.rst. Usage and installation are now in their own RST files for increased modularity, and are included in doc/source/readme.rst. Additional developer documentation has also been created at doc/source/man/ and includes more information on stackviz-export as well as the AngularJS front-end. Change-Id: I1d37194add998cf83a66d380ec7390e31184bdb3
29 lines
969 B
ReStructuredText
29 lines
969 B
ReStructuredText
|
|
Welcome to Stackviz's Manuals!
|
|
========================================================
|
|
|
|
In this directory, you will find detailed documentation describing Stackviz
|
|
components and how they work together.
|
|
|
|
Stackviz is broken up into two distinct components: a Python processing module
|
|
(stackviz/stackviz) and an AngularJS front-end (stackviz/app). Stackviz also
|
|
uses Gulp to manage various tasks including building sites and running tests.
|
|
For information on each of these components, see their corresponding RST entry.
|
|
Below is a listing of each major subdirectory in Stackviz.
|
|
|
|
Directories:
|
|
------------
|
|
- :code:`./app/`: AngularJS front-end.
|
|
- :code:`./doc/`: Stackviz's documentation.
|
|
- :code:`./gulp/`: Gulp used for task management.
|
|
- :code:`./stackviz/`: Python processing module.
|
|
- :code:`./test/`: Unit and e2e tests.
|
|
|
|
Documentation for the Python processing module and AngularJS front-end:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
stackviz-export
|
|
stackviz-front
|