diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-12-02 00:35:21 +0900 |
|---|---|---|
| committer | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2015-12-04 22:07:22 +0900 |
| commit | a90c29deddc599027822dd1ee61b8cd58021f651 (patch) | |
| tree | 7212038536434d02f10a6ec394a2e7b009a4256e | |
| parent | 2f1d84a7879c5db5e974c4482e40734abb062657 (diff) | |
change dirs to use new opnfv doc build script
Change-Id: Ifbf8a881d0e1a962f2e3cf276fe3942b1f03d3ee
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
| -rw-r--r-- | .gitignore | 7 | ||||
| -rw-r--r-- | Makefile | 9 | ||||
| -rw-r--r-- | docs/etc/conf.py | 34 | ||||
| -rw-r--r-- | docs/etc/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 86 | ||||
| -rw-r--r-- | docs/how-to-use-docs/index.rst | 30 | ||||
| -rw-r--r-- | docs/requirements/01-intro.rst (renamed from requirements/01-intro.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/02-usecase.rst (renamed from requirements/02-usecase.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/03-arch.rst (renamed from requirements/03-arch.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/04-gap.rst (renamed from requirements/04-gap.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/05-impl.rst (renamed from requirements/05-impl.rst) | 538 | ||||
| -rw-r--r-- | docs/requirements/06-summary.rst (renamed from requirements/06-summary.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/07-schemas.rst (renamed from requirements/07-schemas.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/08-revision.rst (renamed from requirements/08-revision.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/99-references.rst (renamed from requirements/99-references.rst) | 0 | ||||
| -rw-r--r-- | docs/requirements/glossary.rst (renamed from requirements/glossary.rst) | 0 | ||||
| -rwxr-xr-x | docs/requirements/images/computeflavor.png (renamed from requirements/images/computeflavor.png) | bin | 105698 -> 105698 bytes | |||
| -rw-r--r-- | docs/requirements/images/figure1.png (renamed from requirements/images/figure1.png) | bin | 32278 -> 32278 bytes | |||
| -rwxr-xr-x | docs/requirements/images/figure2.png (renamed from requirements/images/figure2.png) | bin | 149390 -> 149390 bytes | |||
| -rwxr-xr-x | docs/requirements/images/figure3.png (renamed from requirements/images/figure3.png) | bin | 38065 -> 38065 bytes | |||
| -rwxr-xr-x | docs/requirements/images/figure4.png (renamed from requirements/images/figure4.png) | bin | 218419 -> 218419 bytes | |||
| -rwxr-xr-x | docs/requirements/images/figure5.png (renamed from requirements/images/figure5.png) | bin | 38402 -> 38402 bytes | |||
| -rwxr-xr-x | docs/requirements/images/figure6.png (renamed from requirements/images/figure6.png) | bin | 401171 -> 401171 bytes | |||
| -rw-r--r-- | docs/requirements/index.rst (renamed from requirements/index.rst) | 19 | ||||
| -rwxr-xr-x | etc/conf.py | 30 | ||||
| -rw-r--r-- | requirements.txt | 3 | ||||
| -rw-r--r-- | requirements/images/opnfv-logo.png | bin | 2829 -> 0 bytes | |||
| -rw-r--r-- | setup.py | 5 | ||||
| -rw-r--r-- | tox.ini | 16 |
29 files changed, 272 insertions, 505 deletions
@@ -1,4 +1,3 @@ -*.egg-info -.tox -build -plantuml.jar +/build/ +/output/ +/releng/ diff --git a/Makefile b/Makefile deleted file mode 100644 index 73fa622..0000000 --- a/Makefile +++ /dev/null @@ -1,9 +0,0 @@ -BUILDDIR := build - -.PHONY: default clean - -default: - tox - -clean: - rm -rf .tox build diff --git a/docs/etc/conf.py b/docs/etc/conf.py deleted file mode 100644 index 0066035..0000000 --- a/docs/etc/conf.py +++ /dev/null @@ -1,34 +0,0 @@ -import datetime -import sys -import os - -try: - __import__('imp').find_module('sphinx.ext.numfig') - extensions = ['sphinx.ext.numfig'] -except ImportError: - # 'pip install sphinx_numfig' - extensions = ['sphinx_numfig'] - -# numfig: -number_figures = True -figure_caption_prefix = "Fig." - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'OPNFV: Template documentation config' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.0' -release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503..0000000 --- a/docs/etc/opnfv-logo.png +++ /dev/null diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst deleted file mode 100644 index afcf758..0000000 --- a/docs/how-to-use-docs/documentation-example.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. two dots create a comment. please leave this logo at the top of each of your rst files. -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left -.. these two pipes are to seperate the logo from the first title -| -| -How to create documentation for your OPNFV project -================================================== - -this is the directory structure of the docs/ directory that can be found in the root of your project directory - -.. code-block:: bash - - ./etc - ./etc/opnfv-logo.png - ./etc/conf.py - ./how-to-use-docs - ./how-to-use-docs/documentation-example.rst - ./how-to-use-docs/index.rst - -To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst. -This index file must refence your other rst files. - -* Here is an example index.rst - -.. code-block:: bash - - Example Documentation table of contents - ======================================= - - Contents: - - .. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - - Indices and tables - ================== - - * :ref:`search` - - Revision: _sha1_ - - Build date: |today| - - -The Sphinx Build -================ - -When you push documentation changes to gerrit a jenkins job will create html documentation. - -* Verify Jobs -For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result. - -* Merge jobs - -Once you are happy with the look of your documentation you can submit the patchset the merge job will -copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html - -Here are some quick examples of how to use rst markup - -This is a headline:: - - here is some code, note that it is indented - -links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/ - -* Bulleted Items - - **this will be bold** - -.. code-block:: bash - - echo "Heres is a code block with bash syntax highlighting" - - -Leave these at the bottom of each of your documents they are used internally - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst deleted file mode 100644 index 36710b3..0000000 --- a/docs/how-to-use-docs/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: ../etc/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -Example Documentation table of contents -======================================= - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - documentation-example.rst - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/requirements/01-intro.rst b/docs/requirements/01-intro.rst index 6738df2..6738df2 100644 --- a/requirements/01-intro.rst +++ b/docs/requirements/01-intro.rst diff --git a/requirements/02-usecase.rst b/docs/requirements/02-usecase.rst index 15342eb..15342eb 100644 --- a/requirements/02-usecase.rst +++ b/docs/requirements/02-usecase.rst diff --git a/requirements/03-arch.rst b/docs/requirements/03-arch.rst index 8c4db91..8c4db91 100644 --- a/requirements/03-arch.rst +++ b/docs/requirements/03-arch.rst diff --git a/requirements/04-gap.rst b/docs/requirements/04-gap.rst index 9532495..9532495 100644 --- a/requirements/04-gap.rst +++ b/docs/requirements/04-gap.rst diff --git a/requirements/05-impl.rst b/docs/requirements/05-impl.rst index 951c6d6..dd413ea 100644 --- a/requirements/05-impl.rst +++ b/docs/requirements/05-impl.rst @@ -377,33 +377,33 @@ _______________________________________ Susbcription from Consumer to VIM to be notified about network capacity changes .. http:post:: /capacity/network/subscribe - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http POST /capacity/network/subscribe HTTP/1.1 Accept: application/json { - "resourceDescriptor": [ + "resourceDescriptor": [ { "networkResourceTypeId": "publicIps" } - ], - "threshold": [ - { - "capacity_info": "available", - "condition": "lt", - "value": 5 - } - ] - } + ], + "threshold": [ + { + "capacity_info": "available", + "condition": "lt", + "value": 5 + } + ] + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http HTTP/1.1 201 CREATED Content-Type: application/json @@ -419,41 +419,41 @@ ______________________ Request to find out about available, reserved, total and allocated network capacity. .. http:get:: /capacity/network/query - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - GET /capacity/network/query HTTP/1.1 - Accept: application/json + GET /capacity/network/query HTTP/1.1 + Accept: application/json - { - "resourceDescriptor": { - "networkResourceTypeId": "publicIps" - }, - "timePeriod": { - "startTime": "2015-09-28T00:00:00Z", - "stopTime": "2015-09-28T00:05:30Z" + { + "resourceDescriptor": { + "networkResourceTypeId": "publicIps" + }, + "timePeriod": { + "startTime": "2015-09-28T00:00:00Z", + "stopTime": "2015-09-28T00:05:30Z" + } } - } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 200 OK - Content-Type: application/json + HTTP/1.1 200 OK + Content-Type: application/json - { - "lastUpdate": "2015-09-28T00:02:10Z", - "capacityInformation": { - "available": 4, - "reserved": 10, - "total": 64, - "allocated": 50 + { + "lastUpdate": "2015-09-28T00:02:10Z", + "capacityInformation": { + "available": 4, + "reserved": 10, + "total": 64, + "allocated": 50 + } } - } Notify Network Capacity Change Event ____________________________________ @@ -461,27 +461,27 @@ ____________________________________ Notification about network capacity changes .. http:post:: /capacity/network/notification - :noindex: + :noindex: - **Example notification**: + **Example notification**: - .. sourcecode:: http + .. sourcecode:: http - Content-Type: application/json + Content-Type: application/json - { - "notificationId": "yxwvut-srqpon-876543210", - "capacityChangeTime": "2015-09-28T00:02:10Z", - "resourceDescriptor": { - "networkResourceTypeId": "publicIps" - }, - "capacityInformation": { - "available": 4, - "reserved": 10, - "total": 64, - "allocated": 50 - } - } + { + "notificationId": "yxwvut-srqpon-876543210", + "capacityChangeTime": "2015-09-28T00:02:10Z", + "resourceDescriptor": { + "networkResourceTypeId": "publicIps" + }, + "capacityInformation": { + "available": 4, + "reserved": 10, + "total": 64, + "allocated": 50 + } + } Network Resource Reservation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -492,42 +492,42 @@ ___________________________________ Request the reservation of network resource capacity and/or virtual networks, network ports .. http:post:: /reservation/network/create - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - POST /reservation/network/create HTTP/1.1 - Accept: application/json + POST /reservation/network/create HTTP/1.1 + Accept: application/json - { - "startTime": "2015-09-28T01:00:00Z", - "networkReservation": { - "numPublicIps": 2 - } - } + { + "startTime": "2015-09-28T01:00:00Z", + "networkReservation": { + "numPublicIps": 2 + } + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 201 CREATED - Content-Type: application/json + HTTP/1.1 201 CREATED + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-28T01:00:00Z", - "reservationStatus": "initialized", - "reservationId": "wwww-xxxx-yyyy", - "networkReserved": { - "publicIps": [ - "10.2.91.60", - "10.2.91.61" - ] - } - } - } + { + "reservationData": { + "startTime": "2015-09-28T01:00:00Z", + "reservationStatus": "initialized", + "reservationId": "wwww-xxxx-yyyy", + "networkReserved": { + "publicIps": [ + "10.2.91.60", + "10.2.91.61" + ] + } + } + } Query Network Resource Reservation __________________________________ @@ -535,41 +535,41 @@ __________________________________ Request to find out about reserved network resources that the consumer has access to. .. http:get:: /reservation/network/query - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - GET /reservation/network/query HTTP/1.1 - Accept: application/json + GET /reservation/network/query HTTP/1.1 + Accept: application/json - { - "queryReservationFilter": [ - { - "reservationId": "wwww-xxxx-yyyy" - } - ] - } + { + "queryReservationFilter": [ + { + "reservationId": "wwww-xxxx-yyyy" + } + ] + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 200 OK - Content-Type: application/json + HTTP/1.1 200 OK + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-28T01:00:00Z", - "reservationStatus": "active", - "reservationId": "wwww-xxxx-yyyy", - "networkReserved": "publicIps": [ - "10.2.91.60", - "10.2.91.61" - ] - } - } + { + "reservationData": { + "startTime": "2015-09-28T01:00:00Z", + "reservationStatus": "active", + "reservationId": "wwww-xxxx-yyyy", + "networkReserved": "publicIps": [ + "10.2.91.60", + "10.2.91.61" + ] + } + } Update Network Resource Reservation ___________________________________ @@ -577,47 +577,47 @@ ___________________________________ Request to update network resource reservation .. http:post:: /reservation/network/update - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - POST /reservation/network/update HTTP/1.1 - Accept: application/json + POST /reservation/network/update HTTP/1.1 + Accept: application/json - { - "startTime": "2015-09-21T16:00:00Z", - "reservationId": "wwww-xxxx-yyyy" - } + { + "startTime": "2015-09-21T16:00:00Z", + "reservationId": "wwww-xxxx-yyyy" + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 201 CREATED - Content-Type: application/json + HTTP/1.1 201 CREATED + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-21T16:00:00Z", - "reservationStatus": "active", - "reservationId": "wwww-xxxx-yyyy", - "networkReserved": { - "publicIps": [ - "10.2.91.60", - "10.2.91.61" - ] - } - } - } + { + "reservationData": { + "startTime": "2015-09-21T16:00:00Z", + "reservationStatus": "active", + "reservationId": "wwww-xxxx-yyyy", + "networkReserved": { + "publicIps": [ + "10.2.91.60", + "10.2.91.61" + ] + } + } + } Terminate Network Resource Reservation ______________________________________ Request to terminate a network resource reservation .. http:delete:: /reservation/network/(reservation_id) - :noindex: + :noindex: Virtualised Storage Resources ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -642,16 +642,16 @@ Subscription from Consumer to VIM to be notified about storage capacity changes { "resourceDescriptor": [ - { - "storageResourceTypeId": "volumes" - } + { + "storageResourceTypeId": "volumes" + } ], "threshold": [ - { - "capacity_info": "available", - "condition": "lt", - "value": 3 - } + { + "capacity_info": "available", + "condition": "lt", + "value": 3 + } ] } @@ -659,13 +659,13 @@ Subscription from Consumer to VIM to be notified about storage capacity changes .. sourcecode:: http - HTTP/1.1 201 CREATED - Content-Type: application/json + HTTP/1.1 201 CREATED + Content-Type: application/json - { - "created": "2015-09-28T12:00:00Z", - "capacityChangeSubscriptionId": "cdefgh-ijklmn-345678901" - } + { + "created": "2015-09-28T12:00:00Z", + "capacityChangeSubscriptionId": "cdefgh-ijklmn-345678901" + } Query Storage Capacity ______________________ @@ -683,13 +683,13 @@ Request to find out about available, reserved, total and allocated storage capac Accept: application/json { - "resourceDescriptor": { - "storageResourceTypeId": "volumes" - }, - "timePeriod": { - "startTime": "2015-09-28T12:00:00Z", - "stopTime": "2015-09-28T12:04:45Z" - } + "resourceDescriptor": { + "storageResourceTypeId": "volumes" + }, + "timePeriod": { + "startTime": "2015-09-28T12:00:00Z", + "stopTime": "2015-09-28T12:04:45Z" + } } **Example response**: @@ -702,10 +702,10 @@ Request to find out about available, reserved, total and allocated storage capac { "lastUpdate": "2015-09-28T12:01:35Z", "capacityInformation": { - "available": 2, - "reserved": 4, - "total": 10, - "allocated": 4 + "available": 2, + "reserved": 4, + "total": 10, + "allocated": 4 } } @@ -715,26 +715,26 @@ ____________________________________ Notification about storage capacity changes .. http:post:: /capacity/storage/notification - :noindex: + :noindex: - **Example notification**: + **Example notification**: - .. sourcecode:: http + .. sourcecode:: http - Content-Type: application/json + Content-Type: application/json - { - "notificationId": "xwvuts-rqponm-765432109", - "capacityChangeTime": "2015-09-28T12:01:35Z", - "resourceDescriptor": { - "storageResourceTypeId": "volumes" - }, - "capacityInformation": { - "available": 2, - "reserved": 4, - "total": 10, - "allocated": 4 - } + { + "notificationId": "xwvuts-rqponm-765432109", + "capacityChangeTime": "2015-09-28T12:01:35Z", + "resourceDescriptor": { + "storageResourceTypeId": "volumes" + }, + "capacityInformation": { + "available": 2, + "reserved": 4, + "total": 10, + "allocated": 4 + } } Storage Resource Reservation @@ -746,85 +746,85 @@ ___________________________________ Request the reservation of storage resource capacity .. http:post:: /reservation/storage/create - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - POST /reservation/storage/create HTTP/1.1 - Accept: application/json + POST /reservation/storage/create HTTP/1.1 + Accept: application/json - { - "startTime": "2015-09-28T13:00:00Z", - "storagePoolReservation": { - "storageSize": 10, - "numSnapshots": 3, - "numVolumes": 2 - } - } + { + "startTime": "2015-09-28T13:00:00Z", + "storagePoolReservation": { + "storageSize": 10, + "numSnapshots": 3, + "numVolumes": 2 + } + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 201 CREATED - Content-Type: application/json + HTTP/1.1 201 CREATED + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-28T13:00:00Z", - "reservationStatus": "initialized", - "reservationId": "vvvv-wwww-xxxx", - "storagePoolReserved": { - "storageSize": 10, - "numSnapshots": 3, - "numVolumes": 2 - } - } - } + { + "reservationData": { + "startTime": "2015-09-28T13:00:00Z", + "reservationStatus": "initialized", + "reservationId": "vvvv-wwww-xxxx", + "storagePoolReserved": { + "storageSize": 10, + "numSnapshots": 3, + "numVolumes": 2 + } + } + } Query Storage Resource Reservation __________________________________ Request to find out about reserved storage resources that the consumer has access to. .. http:get:: /reservation/storage/query - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - GET /reservation/storage/query HTTP/1.1 - Accept: application/json + GET /reservation/storage/query HTTP/1.1 + Accept: application/json - { - "queryReservationFilter": [ - { - "reservationId": "vvvv-wwww-xxxx" - } - ] - } + { + "queryReservationFilter": [ + { + "reservationId": "vvvv-wwww-xxxx" + } + ] + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 200 OK - Content-Type: application/json + HTTP/1.1 200 OK + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-28T13:00:00Z", - "reservationStatus": "active", - "reservationId": "vvvv-wwww-xxxx", - "storagePoolReserved": { - "storageSize": 10, - "numSnapshots": 3, - "numVolumes": 2 + { + "reservationData": { + "startTime": "2015-09-28T13:00:00Z", + "reservationStatus": "active", + "reservationId": "vvvv-wwww-xxxx", + "storagePoolReserved": { + "storageSize": 10, + "numSnapshots": 3, + "numVolumes": 2 + } } - } - } + } Update Storage Resource Reservation ___________________________________ @@ -832,58 +832,58 @@ ___________________________________ Request to update storage resource reservation .. http:post:: /reservation/storage/update - :noindex: + :noindex: - **Example request**: + **Example request**: - .. sourcecode:: http + .. sourcecode:: http - POST /reservation/storage/update HTTP/1.1 + POST /reservation/storage/update HTTP/1.1 Accept: application/json - { - "startTime": "2015-09-20T23:00:00Z", - "reservationId": "vvvv-wwww-xxxx" - } + { + "startTime": "2015-09-20T23:00:00Z", + "reservationId": "vvvv-wwww-xxxx" + } - **Example response**: + **Example response**: - .. sourcecode:: http + .. sourcecode:: http - HTTP/1.1 201 CREATED - Content-Type: application/json + HTTP/1.1 201 CREATED + Content-Type: application/json - { - "reservationData": { - "startTime": "2015-09-20T23:00:00Z", - "reservationStatus": "active", - "reservationId": "vvvv-wwww-xxxx", - "storagePoolReserved": { - "storageSize": 10, - "numSnapshots": 3, - "numVolumes": 2 - } - } - } + { + "reservationData": { + "startTime": "2015-09-20T23:00:00Z", + "reservationStatus": "active", + "reservationId": "vvvv-wwww-xxxx", + "storagePoolReserved": { + "storageSize": 10, + "numSnapshots": 3, + "numVolumes": 2 + } + } + } Terminate Storage Resource Reservation ______________________________________ Request to terminate a storage resource reservation .. http:delete:: /reservation/storage/(reservation_id) - :noindex: + :noindex: Detailed Message Flows ---------------------- Resource Capacity Management -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. figure:: images/figure5.png - :name: figure5 - :width: 90% + :name: figure5 + :width: 90% - Capacity Management Scenario + Capacity Management Scenario :numref:`figure5` shows a detailed message flow between the consumers and the functional blocks inside the VIM and has the following steps: @@ -901,13 +901,13 @@ Step 4: The consumer queries the Capacity Manager to retrieve capacity detailed information Resource Reservation -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ .. figure:: images/figure6.png - :name: figure6 - :width: 90% + :name: figure6 + :width: 90% - Resource Reservation for Future Use Scenario + Resource Reservation for Future Use Scenario :numref:`figure6` shows a detailed message flow between the consumers and the functional blocks inside the VIM and has the following steps: diff --git a/requirements/06-summary.rst b/docs/requirements/06-summary.rst index 381ab87..381ab87 100644 --- a/requirements/06-summary.rst +++ b/docs/requirements/06-summary.rst diff --git a/requirements/07-schemas.rst b/docs/requirements/07-schemas.rst index fdcd249..fdcd249 100644 --- a/requirements/07-schemas.rst +++ b/docs/requirements/07-schemas.rst diff --git a/requirements/08-revision.rst b/docs/requirements/08-revision.rst index b543fa5..b543fa5 100644 --- a/requirements/08-revision.rst +++ b/docs/requirements/08-revision.rst diff --git a/requirements/99-references.rst b/docs/requirements/99-references.rst index 4dd4845..4dd4845 100644 --- a/requirements/99-references.rst +++ b/docs/requirements/99-references.rst diff --git a/requirements/glossary.rst b/docs/requirements/glossary.rst index 1addb9c..1addb9c 100644 --- a/requirements/glossary.rst +++ b/docs/requirements/glossary.rst diff --git a/requirements/images/computeflavor.png b/docs/requirements/images/computeflavor.png Binary files differindex 3ea3dba..3ea3dba 100755 --- a/requirements/images/computeflavor.png +++ b/docs/requirements/images/computeflavor.png diff --git a/requirements/images/figure1.png b/docs/requirements/images/figure1.png Binary files differindex 065a995..065a995 100644 --- a/requirements/images/figure1.png +++ b/docs/requirements/images/figure1.png diff --git a/requirements/images/figure2.png b/docs/requirements/images/figure2.png Binary files differindex dd002a2..dd002a2 100755 --- a/requirements/images/figure2.png +++ b/docs/requirements/images/figure2.png diff --git a/requirements/images/figure3.png b/docs/requirements/images/figure3.png Binary files differindex 20e51c7..20e51c7 100755 --- a/requirements/images/figure3.png +++ b/docs/requirements/images/figure3.png diff --git a/requirements/images/figure4.png b/docs/requirements/images/figure4.png Binary files differindex e0c96a1..e0c96a1 100755 --- a/requirements/images/figure4.png +++ b/docs/requirements/images/figure4.png diff --git a/requirements/images/figure5.png b/docs/requirements/images/figure5.png Binary files differindex 4e161f4..4e161f4 100755 --- a/requirements/images/figure5.png +++ b/docs/requirements/images/figure5.png diff --git a/requirements/images/figure6.png b/docs/requirements/images/figure6.png Binary files differindex 8aeec23..8aeec23 100755 --- a/requirements/images/figure6.png +++ b/docs/requirements/images/figure6.png diff --git a/requirements/index.rst b/docs/requirements/index.rst index bd5bbfb..9e50420 100644 --- a/requirements/index.rst +++ b/docs/requirements/index.rst @@ -1,19 +1,3 @@ -.. - This work is licensed under a Creative Commons Attribution 3.0 Unported - License. - - http://creativecommons.org/licenses/by/3.0/legalcode - -.. image:: images/opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -.. title:: - Promise - - **************************** Promise: Resource Management **************************** @@ -60,6 +44,3 @@ Promise: Resource Management 07-schemas.rst 08-revision.rst 99-references.rst - -.. - vim: set tabstop=4 expandtab textwidth=80: diff --git a/etc/conf.py b/etc/conf.py deleted file mode 100755 index 88fcb28..0000000 --- a/etc/conf.py +++ /dev/null @@ -1,30 +0,0 @@ -import datetime -import sys -import os - -needs_sphinx = '1.3' - -extensions = ['sphinxcontrib.httpdomain'] - -numfig = True - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'Promise', u'Promise Project', u'OPNFV')] -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -#latex_domain_indices = False -#latex_use_modindex = False - -latex_elements = { - 'printindex': '', -} - -project = u'Promise: Resource Management' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'1.0.2' -release = u'1.0.2' - diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index fea41a9..0000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -sphinx -sphinx_numfig -sphinxcontrib-httpdomain diff --git a/requirements/images/opnfv-logo.png b/requirements/images/opnfv-logo.png Binary files differdeleted file mode 100644 index 1519503..0000000 --- a/requirements/images/opnfv-logo.png +++ /dev/null diff --git a/setup.py b/setup.py deleted file mode 100644 index 8ce1bf4..0000000 --- a/setup.py +++ /dev/null @@ -1,5 +0,0 @@ -from setuptools import setup - -setup( - name = "promise", -) diff --git a/tox.ini b/tox.ini deleted file mode 100644 index 7cab86b..0000000 --- a/tox.ini +++ /dev/null @@ -1,16 +0,0 @@ -[tox] -minversion = 1.4 -envlist = pdf,html -skipsdist = True - -[testenv] -deps = -r{toxinidir}/requirements.txt - -[testenv:pdf] -commands = - sphinx-build -b latex -c etc -d build/doctrees requirements build/requirements/latex - make -C build/requirements/latex LATEXOPTS='--interaction=nonstopmode' all-pdf - -[testenv:html] -commands = - sphinx-build -b html -c etc -d build/doctrees requirements build/requirements/html |
