Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated requirements for building documentation #489

Open
pjdobrowolski opened this issue Mar 6, 2024 · 4 comments
Open

Outdated requirements for building documentation #489

pjdobrowolski opened this issue Mar 6, 2024 · 4 comments

Comments

@pjdobrowolski
Copy link
Contributor

pjdobrowolski commented Mar 6, 2024

Hi,
I can't build docs because requirements are quite outdated and don't match with any new Sphinx, docutils or Breathe. Does anyone have latest packages used during building?

Our documentation processing has been tested to run with:

Python 3.6.3

Doxygen version 1.8.13

Sphinx version 1.7.5

Breathe version 4.9.1

docutils version 0.14

sphinx_rtd_theme version 0.4.0

Intall-documentation-tools

@plbossart
Copy link
Member

wasn't this updated with #485 ?

Maybe we need to publish the updated docs @deb-intel?

@pjdobrowolski
Copy link
Contributor Author

pjdobrowolski commented Mar 7, 2024

I finally built documentation with

Python 3.8.10
Doxygen 1.8.17

Package                        Version
------------------------------ --------------------
breathe                        4.35.0
docutils                       0.18.1
sphinx                         6.2.1
sphinx-rtd-theme               0.4.3
sphinx-tabs                    1.1.13
sphinxcontrib-applehelp        1.0.4
sphinxcontrib-blockdiag        3.0.0
sphinxcontrib-devhelp          1.0.2
sphinxcontrib-htmlhelp         2.0.1
sphinxcontrib-jsmath           1.0.1
sphinxcontrib-plantuml         0.28
sphinxcontrib-qthelp           1.0.3
sphinxcontrib-serializinghtml  1.1.5
sphinxcontrib-svg2pdfconverter 1.0.1
sphinxcontrib-websupport       1.2.4

@lgirdwood
Copy link
Member

@marc-hb are we able to capture the above in the docs ?

@deb-intel
Copy link
Collaborator

@lgirdwood @marc-hb Don't worry. @intelkevinputnam and I tested what is needed and what doesn't work. Give me a day or so to submit a PR (with changes) before you guys do anything. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants