openstack
/
cyborg
Code Issues Proposed changes

Fix doc build warnings 

Fix a couple of warnings that show up when tox -e docs is run.

Also, improve RST formatting and remove extra lines.

Treat warnings as errors to not have those come in again.

Change-Id: I2bdd321a0702168d19ee650c37aabe7f028780c0
This commit is contained in:
Andreas Jaeger 2018-02-14 09:24:57 +01:00
parent fe04417036
commit 6881e76a91
4 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/index.rst
View File

@ -1,10 +1,6 @@
.. cyborg documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Cyborg's documentation!
========================================================
==================================
Cyborg is a general management framework for accelerators
@ -16,31 +12,34 @@ Overview
user/introduction
user/architecture
user/usage
User Documentation
----------
-------------------
**Installation**
Installation
~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
install/installation.rst
install/installation
**API**
API
~~~
.. toctree::
:maxdepth: 1
admin/api.rst
admin/api
Developer Documentation
-----------------
-----------------------
.. toctree::
:maxdepth: 1
contributor/contributing.rst
contributor/contributing
Indices and tables
@ -49,4 +48,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

2
doc/source/user/architecture.rst
View File

@ -3,7 +3,7 @@ Cyborg architecture
Cyborg design can be described by following diagram:
.. image:: figures/cyborg-architecture.png
.. image:: ../figures/cyborg-architecture.png
:width: 700 px
:scale: 99 %
:align: left

22
doc/source/user/introduction.rst
View File

@ -13,15 +13,17 @@ OpenStack Acceleration Discussion Started from Telco Requirements:
Transition to Cyborg Project:
* From a long period of conversation and discussion within the OpenStack community,
we found that the initial goal of Nomad project to address acceleration management
in Telco is too limited. From design summit session in Barcelona Summit, we have
developers from Scientific WG help us understanding the need for acceleration management
in HPC cloud, and we also had a lot of discussion on the Public Cloud support of
accelerated instances.
* From a long period of conversation and discussion within the
OpenStack community, we found that the initial goal of Nomad project
to address acceleration management in Telco is too limited. From
design summit session in Barcelona Summit, we have developers from
Scientific WG help us understanding the need for acceleration
management in HPC cloud, and we also had a lot of discussion on the
Public Cloud support of accelerated instances.
* We decide to formally establish a project that will work on the management framework
for dedicated devices in OpenStack, and there comes the Cyborg Project.
* We decide to formally establish a project that will work on the
management framework for dedicated devices in OpenStack, and there
comes the Cyborg Project.
Definition Breakdown
--------------------
@ -34,7 +36,3 @@ Definition Breakdown
**Accelerators:**
* Software: dpdk/spdk, pmem, ...
* Hardware: FPGA, GPU, ARM SoC, NVMe SSD, CCIX based Caches, ...

1
setup.cfg
View File

@ -40,6 +40,7 @@ cyborg.database.migration_backend =
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html