thesofproject / sof-docs

Documentation for SOF
Other
16 stars 72 forks source link

Outdated requirements for building documentation #489

Open pjdobrowolski opened 4 months ago

pjdobrowolski commented 4 months ago

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 commented 4 months ago

wasn't this updated with https://github.com/thesofproject/sof-docs/pull/485 ?

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

pjdobrowolski commented 4 months ago

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 commented 2 months ago

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

deb-intel commented 2 months ago

@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!