openstack/nova
Code Issues Proposed changes

remove sphinxcontrib-seqdiag

Browse Source 
This removes the one seqdiag that is in our docs which drops the whole
chain of sphinxcontrib-seqdiag which requires Pillow, which requires
that you have a C compiler and jpeg-dev package on your environment to
build documenation for a python project.

Change-Id: Ie7615d48b5524b5e5e1159a25c357f5b3f0eee0e
This commit is contained in:
Sean Dague 2015-10-02 07:09:18 -04:00
parent 251e09ab69
commit f87fbc02b6
3 changed files with 35 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -33,7 +33,6 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.graphviz',
'oslosphinx',
"ext.support_matrix",
'sphinxcontrib.seqdiag',
'oslo_config.sphinxconfiggen',
]

62
doc/source/vmstates.rst
View File

@ -137,33 +137,41 @@ The following diagram shows the sequence of VM states, task states, and
power states when a new VM instance is created.
.. seqdiag::
.. this is commented out because in order to turn this into a picture,
we need a rather large chain of python dependencies which includes
natively compiling against libjpeg. That's a huge cost for 1
diagram that's not clearly useful in that way.
seqdiag {
edge_length = 250;
span_height = 40;
node_width=200;
default_note_color = lightblue;
I suggest we redo this as SVG or something to get the information
without the dependency change.
// Use note (put note on rightside)
api [label="Compute.api"];
manager [label="Compute.manager"];
api -> manager [label = "create_db_entry_for_new_instance",
note = "VM: Building
Task: Scheduling
Power: No State"];
manager -> manager [label="_start_building",
note ="VM: Building
.. seqdiag::
seqdiag {
edge_length = 250;
span_height = 40;
node_width=200;
default_note_color = lightblue;
// Use note (put note on rightside)
api [label="Compute.api"];
manager [label="Compute.manager"];
api -> manager [label = "create_db_entry_for_new_instance",
note = "VM: Building
Task: Scheduling
Power: No State"];
manager -> manager [label="_start_building",
note ="VM: Building
Task: None"];
manager -> manager [label="_allocate_network",
note ="VM: Building
Task: Networking"];
manager -> manager [label="_prep_block_device",
note ="VM: Building
Task: Block_Device_Mapping"];
manager -> manager [label="_spawn",
note ="VM: Building
Task: Spawning"];
api <-- manager [note ="VM: Active
Task: None"];
manager -> manager [label="_allocate_network",
note ="VM: Building
Task: Networking"];
manager -> manager [label="_prep_block_device",
note ="VM: Building
Task: Block_Device_Mapping"];
manager -> manager [label="_spawn",
note ="VM: Building
Task: Spawning"];
api <-- manager [note ="VM: Active
Task: None"];
}
}

4
test-requirements.txt
View File

@ -14,10 +14,6 @@ python-ironicclient>=0.8.0
python-subunit>=0.0.18
requests-mock>=0.6.0 # Apache-2.0
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
# NOTE(tonyb): Pillow isn't used directly by nova but it's needed for
# sphinxcontrib-seqdiag. Make sure we honnor g-r caps
Pillow<3.0.0,>=2.4.0 # MIT
sphinxcontrib-seqdiag
oslosphinx>=2.5.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
os-testr>=0.4.1