Skip to content

Outdated requirements for building documentation #489

Open
Open
Outdated requirements for building documentation#489

Description

@pjdobrowolski
pjdobrowolski
opened on 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

Activity

  1. plbossart commented on Mar 6, 2024

    @plbossart
    plbossart
    on Mar 6, 2024
    Member

    wasn't this updated with #485 ?

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

  2. pjdobrowolski commented on Mar 7, 2024

    @pjdobrowolski
    pjdobrowolski
    on Mar 7, 2024
    ContributorAuthor

    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

  3. lgirdwood commented on Apr 16, 2024

    @lgirdwood
    lgirdwood
    on Apr 16, 2024
    Member

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

  4. deb-intel commented on Apr 16, 2024

    @deb-intel
    deb-intel
    on Apr 16, 2024
    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions