Merge "[doc-migration] Reorganize the Tricircle doc/source folder"
This commit is contained in:
commit
6cd177b73c
|
@ -0,0 +1,3 @@
|
||||||
|
================================
|
||||||
|
Command-Line Interface Reference
|
||||||
|
================================
|
|
@ -0,0 +1,9 @@
|
||||||
|
=====================
|
||||||
|
Tricircle Admin Guide
|
||||||
|
=====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
api_v1
|
||||||
|
cli
|
|
@ -0,0 +1,8 @@
|
||||||
|
=============================
|
||||||
|
Tricircle Configuration Guide
|
||||||
|
=============================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
configuration
|
|
@ -1,4 +0,0 @@
|
||||||
=============
|
|
||||||
Contributing
|
|
||||||
=============
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
============
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -0,0 +1,8 @@
|
||||||
|
============================
|
||||||
|
Tricircle Contribution Guide
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
contributing
|
|
@ -7,26 +7,44 @@
|
||||||
Welcome to Tricircle's documentation!
|
Welcome to Tricircle's documentation!
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
Contents
|
Tricircle User Guide
|
||||||
========
|
====================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
readme
|
user/index
|
||||||
usage
|
|
||||||
installation-guide
|
|
||||||
configuration
|
|
||||||
networking-guide
|
|
||||||
vlan-aware-vms-guide
|
|
||||||
service-function-chaining-guide
|
|
||||||
api_v1
|
|
||||||
contributing
|
|
||||||
|
|
||||||
|
Tricircle Contribution Guide
|
||||||
|
============================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
contributor/index
|
||||||
|
|
||||||
Indices and tables
|
Tricircle Admin Guide
|
||||||
==================
|
=====================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
* :ref:`genindex`
|
admin/index
|
||||||
* :ref:`search`
|
|
||||||
|
Tricircle Installation Guide
|
||||||
|
============================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
install/index
|
||||||
|
|
||||||
|
Tricircle Configuration Guide
|
||||||
|
=============================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
configuration/index
|
||||||
|
|
||||||
|
Tricircle Networking Guide
|
||||||
|
==========================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
networking/index
|
|
@ -0,0 +1,8 @@
|
||||||
|
============================
|
||||||
|
Tricircle Installation Guide
|
||||||
|
============================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
installation-guide
|
|
@ -0,0 +1,8 @@
|
||||||
|
==========================
|
||||||
|
Tricircle Networking Guide
|
||||||
|
==========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
networking-guide
|
|
@ -10,3 +10,5 @@ typical networking mode will be described.
|
||||||
.. include:: ./networking-terms.rst
|
.. include:: ./networking-terms.rst
|
||||||
.. include:: ./networking-prerequisites.rst
|
.. include:: ./networking-prerequisites.rst
|
||||||
.. include:: ./networking-scenarios.rst
|
.. include:: ./networking-scenarios.rst
|
||||||
|
.. include:: ./service-function-chaining-guide.rst
|
||||||
|
.. include:: ./vlan-aware-vms-guide.rst
|
|
@ -3,7 +3,7 @@ Networking Scenario
|
||||||
===================
|
===================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 4
|
||||||
|
|
||||||
networking-guide-direct-provider-networks.rst
|
networking-guide-direct-provider-networks.rst
|
||||||
networking-guide-multiple-external-networks.rst
|
networking-guide-multiple-external-networks.rst
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../README.rst
|
|
|
@ -0,0 +1,9 @@
|
||||||
|
====================
|
||||||
|
Tricircle User Guide
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
readme
|
||||||
|
usage
|
|
@ -0,0 +1,2 @@
|
||||||
|
.. include:: ../../../README.rst
|
||||||
|
:start-line: 10
|
|
@ -1,6 +1,6 @@
|
||||||
======
|
=====
|
||||||
Usage
|
Usage
|
||||||
======
|
=====
|
||||||
|
|
||||||
To use tricircle in a project::
|
To use tricircle in a project::
|
||||||
|
|
|
@ -0,0 +1,44 @@
|
||||||
|
.. tricircle documentation master file, created by
|
||||||
|
sphinx-quickstart on Wed Dec 2 17:00:36 2015.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
=====================================
|
||||||
|
Welcome to Tricircle's documentation!
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
User Documentation
|
||||||
|
==================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
user/index
|
||||||
|
|
||||||
|
Contributor Guide
|
||||||
|
=================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
contributor/index
|
||||||
|
|
||||||
|
Admin Guide
|
||||||
|
===========
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
admin/index
|
||||||
|
|
||||||
|
Installation Guide
|
||||||
|
==================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
install/index
|
||||||
|
|
||||||
|
Configuration Guide
|
||||||
|
===================
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
configuration/index
|
||||||
|
|
Loading…
Reference in New Issue