Skip to content

Commit

Permalink
config: Upgrade Sphinx and dependencies
Browse files Browse the repository at this point in the history
ReadtheDocs now require at least version 5.0 of Sphinx. We've been using
4.5.0 and therefore we needed to upgrade to a more recent version.

Sphinx:
- Upgrade Sphinx to v7.2.6.
- Upgrade all packages and modules needed to the most recent versions as
  of today.
- Replace 'sphinx_panels' (deprecated) with 'sphinx_design'.
- Sort the packages and modules alphabetically in the requirements.txt
  file.

Errors:
- When doing the upgrade we got multiple errors from the SPMC pages, it
  looks like the way to refer to an icon has been changed from 'opticon'
  to 'octicon'. To avoid the error when upgrading, fix this in the same
  commit.

Signed-off-by: Joakim Bech <[email protected]>
Acked-by: Jerome Forissier <[email protected]>
Acked-by: Jens Wiklander <[email protected]>
  • Loading branch information
jbech-linaro committed Jan 19, 2024
1 parent a9f89ba commit 587e690
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions architecture/spmc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -286,10 +286,10 @@ access to the Normal World buffers.
FF-A compliance
===============

.. |ffa_fs| replace:: :opticon:`check-circle-fill`
.. |ffa_ps| replace:: :opticon:`check-circle`
.. |ffa_ns| replace:: :opticon:`x`
.. |ffa_na| replace:: :opticon:`horizontal-rule`
.. |ffa_fs| replace:: :octicon:`check-circle-fill`
.. |ffa_ps| replace:: :octicon:`check-circle`
.. |ffa_ns| replace:: :octicon:`x`
.. |ffa_na| replace:: :octicon:`horizontal-rule`

Legend
------
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.graphviz',
'sphinx_panels',
'sphinx_design',
'sphinxcontrib.plantuml',
'sphinx_tabs.tabs',
]
Expand Down
12 changes: 6 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
sphinx-rtd-theme
sphinxcontrib-plantuml==0.24
Pillow==9.3.0
sphinx-tabs
sphinx-panels==0.6.0
sphinx==4.5.0
pillow==10.2.0
Sphinx==7.2.6
sphinxcontrib-plantuml==0.27
sphinx_design==0.5.0
sphinx-rtd-theme==2.0.0
sphinx-tabs==3.4.4

0 comments on commit 587e690

Please sign in to comment.