Doc: remove sphinxcontrib-*diag from doc dependencies

Code Issues Proposed changes

sphinxcontrib-blockdiag, sphinxcontrib-nwdiag and
sphinxcontrib-seqdiag projects are no longer maintained, see [1].
Remove these from the dependencies list and use png images
instead of building them from blockdiag files.
To keep the original source I do not delete the *.blockdiag files.
[1]: https://lists.openstack.org/archives/list/openstack-discuss@lists.openstack.org/thread/4IID4UEXY4PJJGBTMFMTRYLKJIN4GOQ6/
Change-Id: I792d18e2dd6771a6f7eabfeb621c9efc4b47901f

This commit is contained in:

elajkat

2024年08月28日 15:18:11 +02:00

parent e62d94fc98

commit b834f0cedc

7 changed files with 4 additions and 14 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

3
doc/requirements.txt

View File

@@ -6,6 +6,3 @@ openstackdocstheme>=2.2.1 # Apache-2.0

reno>=3.1.0 # Apache-2.0

oslo.config>=5.2.0 # Apache-2.0

oslo.policy>=3.12.0 # Apache-2.0

sphinxcontrib-blockdiag>=1.5.4 # BSD

sphinxcontrib-seqdiag>=0.8.4 # BSD

7
doc/source/conf.py

View File

@@ -21,8 +21,6 @@ sys.path.insert(0, os.path.abspath('../..'))

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

extensions = [

'sphinx.ext.autodoc',

'sphinxcontrib.blockdiag',

'sphinxcontrib.seqdiag',

#'sphinx.ext.intersphinx',

'openstackdocstheme',

'oslo_config.sphinxext',

@@ -63,11 +61,6 @@ pygments_style = 'native'

# Example configuration for intersphinx: refer to the Python standard library.

#intersphinx_mapping = {'http://docs.python.org/': None}

#blockdiag_antialias = True

seq_antialias = True

seqdiag_html_image_format = "svg"

blockdiag_html_image_format = "svg"

# -- Options for HTML output --------------------------------------------------

# The theme to use for HTML and HTML Help pages. Major themes that come with

2
doc/source/user/drivers/bagpipe/index.rst

View File

@@ -26,7 +26,7 @@ nodes of BGP VPN instances and of their MPLS dataplane.

Example with the OpenVSwitch mechanism driver and agent:

.. blockdiag:: overview.blockdiag

.. image:: ../../figures/overview_blockdiag.png

Limitations

-----------

BIN
doc/source/user/figures/components_sdn_blockdiag.png Normal file

View File

Binary file not shown.

Side by Side

After

Width: | Height: | Size: 14 KiB

BIN
doc/source/user/figures/overview_blockdiag.png Normal file

View File

Binary file not shown.

Side by Side

After

Width: | Height: | Size: 16 KiB

BIN
doc/source/user/figures/workflows_seqdiag.png Normal file

View File

Binary file not shown.

Side by Side

After

Width: | Height: | Size: 51 KiB

6
doc/source/user/overview.rst

View File

@@ -95,7 +95,7 @@ So there are two workflows, one for the admin, one for a tenant.

Sequence diagram summarizing these two workflows:

.. seqdiag:: workflows.seqdiag

.. image:: figures/workflows_seqdiag.png

Component architecture overview

@@ -103,12 +103,12 @@ Component architecture overview

This diagram gives an overview of the architecture:

.. blockdiag:: components-sdn.blockdiag

.. image:: figures/components_sdn_blockdiag.png

This second diagram depicts how the *bagpipe* reference driver implements its

backend:

.. blockdiag:: drivers/bagpipe/overview.blockdiag

.. image:: figures/overview_blockdiag.png

References

----------