CSIT doc: Add chapter numbering 12/4912/2
authorTibor Frank <tifrank@cisco.com>
Fri, 27 Jan 2017 13:50:31 +0000 (14:50 +0100)
committerPeter Mikus <pmikus@cisco.com>
Tue, 31 Jan 2017 12:31:25 +0000 (12:31 +0000)
Change-Id: I5cdcda0461e6f4bdabd91ea440edf7a71db9afd9
Signed-off-by: Tibor Frank <tifrank@cisco.com>
resources/tools/doc_gen/src/conf.py
resources/tools/doc_gen/src/index.rst
resources/tools/doc_gen/src/indices.rst [new file with mode: 0644]
resources/tools/doc_gen/src/overview.rst [new file with mode: 0644]
resources/tools/doc_gen/src/requirements.txt

index e418685..9d39da0 100644 (file)
@@ -54,7 +54,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'CSIT'
-copyright = u'2016, CSIT'
+copyright = u'2017, FD.io'
 author = u'CSIT'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -62,9 +62,9 @@ author = u'CSIT'
 # built documents.
 #
 # The short X.Y version.
-version = u'master'
+version = u'master'
 # The full version, including alpha/beta/rc tags.
-release = u'master'
+release = u'master'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
index b92ecd6..77c6966 100644 (file)
@@ -1,78 +1,14 @@
-.. |csit| replace:: Continuous System Integration and Testing
-
-
-|csit| Description
-==================
-
-#. Development of software code for fully automated VPP code testing, functionality, performance, regression and new functions.
-#. Execution of CSIT test suites on VPP code running on LF FD.io virtual and physical compute environments.
-#. Integration with FD.io continuous integration systems (Gerrit, Jenkins and such).
-#. Identified existing FD.io project dependencies and interactions:
-    - vpp - Vector Packet Processing.
-    - honeycomb - Honeycomb Agent for management plane testing.
-    - ci-management - Management repo for Jenkins Job Builder, script and management related to the Jenkins CI configuration.
-
-Project Scope
--------------
-
-#. Automated regression testing of VPP code changes
-    - Functionality of VPP data plane, network control plane, management plane against functional specifications.
-    - Performance of VPP data plane including non-drop-rate packet throughput and delay, against established reference benchmarks.
-    - Performance of network control plane against established reference benchmarks.
-    - Performance of management plane against established reference benchmarks.
-#. Test case definitions driven by supported and planned VPP functionality, interfaces and performance:
-    - Uni-dimensional tests: Data plane, (Network) Control plane, Management plane.
-    - Multi-dimensional tests: Use case driven.
-#. Integration with FD.io Continuous Integration system including FD.io Gerrit and Jenkins
-    - Automated test execution triggered by VPP-VERIFY jobs other VPP and CSIT project jobs.
-#. Integration with LF VPP test execution environment
-    - Functional tests execution on LF hosted VM environment.
-    - Performance and functional tests execution on LF hosted physical compute environment.
-    - Subset of tests executed on LF hosted physical compute running VIRL (Virtual Internet Routing Lab).
-
-|csit| Documentation
---------------------
-
-Python Library
-##############
+Contents
+--------
 
 .. toctree::
-   :maxdepth: 2
+   :numbered:
+   :maxdepth: 1
    :glob:
-   
-   resources.libraries.python
-
-Robot Library
-#############
 
-.. toctree::
-   :maxdepth: 2
-   :glob:
-   
+   overview
+   resources.libraries.python
    resources.libraries.robot
-
-Functional Tests
-################
-
-.. toctree::
-   :maxdepth: 3
-   :glob:
-   
    tests.func
-
-Performance Tests
-#################
-
-.. toctree::
-   :maxdepth: 2
-   :glob:
-   
    tests.perf
-   
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   indices
diff --git a/resources/tools/doc_gen/src/indices.rst b/resources/tools/doc_gen/src/indices.rst
new file mode 100644 (file)
index 0000000..d46b839
--- /dev/null
@@ -0,0 +1,6 @@
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/resources/tools/doc_gen/src/overview.rst b/resources/tools/doc_gen/src/overview.rst
new file mode 100644 (file)
index 0000000..f9cc4e4
--- /dev/null
@@ -0,0 +1,54 @@
+.. |csit| replace:: Continuous System Integration and Testing
+
+CSIT Description
+================
+
+#. Development of software code for fully automated VPP code testing,
+   functionality, performance, regression and new functions.
+
+#. Execution of CSIT test suites on VPP code running on LF FD.io virtual and
+   physical compute environments.
+
+#. Integration with FD.io continuous integration systems (Gerrit, Jenkins and
+   such).
+
+#. Identified existing FD.io project dependencies and interactions:
+
+    - vpp - Vector Packet Processing.
+    - honeycomb - Honeycomb Agent for management plane testing.
+    - ci-management - Management repo for Jenkins Job Builder, script and
+      management related to the Jenkins CI configuration.
+
+Project Scope
+-------------
+
+#. Automated regression testing of VPP code changes
+
+    - Functionality of VPP data plane, network control plane, management plane
+      against functional specifications.
+    - Performance of VPP data plane including non-drop-rate packet throughput
+      and delay, against established reference benchmarks.
+    - Performance of network control plane against established reference
+      benchmarks.
+    - Performance of management plane against established reference benchmarks.
+
+#. Test case definitions driven by supported and planned VPP functionality,
+   interfaces and performance:
+
+    - Uni-dimensional tests: Data plane, (Network) Control plane, Management
+      plane.
+    - Multi-dimensional tests: Use case driven.
+
+#. Integration with FD.io Continuous Integration system including FD.io Gerrit
+   and Jenkins
+
+    - Automated test execution triggered by VPP-VERIFY jobs other VPP and CSIT
+      project jobs.
+
+#. Integration with LF VPP test execution environment
+
+    - Functional tests execution on LF hosted VM environment.
+    - Performance and functional tests execution on LF hosted physical compute
+      environment.
+    - Subset of tests executed on LF hosted physical compute running VIRL
+      (Virtual Internet Routing Lab).
index 8f3e9a5..cf6b0e6 100644 (file)
@@ -1,3 +1,3 @@
-Sphinx==1.4.8
-sphinxcontrib_robotdoc==0.8.0
+Sphinx
+sphinxcontrib_robotdoc
 sphinx-rtd-theme
\ No newline at end of file

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.