openstack/octavia
Code Issues Proposed changes

Remove use of sphinxcontrib-*diag packages

Browse Source 
These are no longer maintained, with the last release for some nearly 5
years ago. Remove references to them.

[1] https://pypi.org/project/sphinxcontrib-blockdiag/
[2] https://pypi.org/project/sphinxcontrib-seqdiag/
[3] https://pypi.org/project/sphinxcontrib-nwdiag/

Change-Id: I6271aa373b06d8c6430e7643f595b4ed8beae82b
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2024-08-26 18:14:16 +01:00
parent a4317a80d6
commit 659500bced
3 changed files with 0 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/requirements.txt
View File

@ -1,12 +1,7 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# Docs
hacking>=3.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
sphinxcontrib-actdiag>=0.8.5 # BSD
sphinxcontrib-apidoc>=0.2.1 # BSD
sphinxcontrib-nwdiag>=0.9.5 # BSD
docutils>=0.11 # OSI-Approved Open Source, Public Domain
sphinx>=2.0.0,!=2.1.0 # BSD
graphviz!=0.5.0,>=0.4 # MIT License

2
doc/source/conf.py
View File

@ -56,8 +56,6 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinxcontrib.actdiag',
'sphinxcontrib.nwdiag',
'sphinx.ext.graphviz',
'sphinx_feature_classification.support_matrix',
'openstackdocstheme',

71
specs/template.rst
View File

@ -51,77 +51,6 @@ asciiflow::
| +-----+ +--------+ |
+----------+ +-----------+ +----------+
actdiag
.. actdiag::
actdiag {
write -> convert -> image
lane user {
label = "User"
write [label = "Writing reST"];
image [label = "Get diagram IMAGE"];
}
lane actdiag {
convert [label = "Convert reST to Image"];
}
}
nwdiag
.. nwdiag::
nwdiag {
network dmz {
address = "210.x.x.x/24"
web01 [address = "210.x.x.1"];
web02 [address = "210.x.x.2"];
}
network internal {
address = "172.x.x.x/24";
web01 [address = "172.x.x.1"];
web02 [address = "172.x.x.2"];
db01;
db02;
}
}
graphviz
.. graphviz::
digraph G {
label="Sample Graph"
subgraph cluster_0 {
style=filled;
color=lightgrey;
node [style=filled,color=white];
a0 -> a1 -> a2 -> a3;
label = "process #1";
}
subgraph cluster_1 {
node [style=filled];
b0 -> b1 -> b2 -> b3;
label = "process #2";
color=blue
}
start -> a0;
start -> b0;
a1 -> b3;
b2 -> a3;
a3 -> a0;
a3 -> end;
b3 -> end;
start [shape=Mdiamond];
end [shape=Msquare];
}
graphviz (external file)
.. graphviz:: example.dot