Skip to content

Conversation

@andped10
Copy link
Contributor

@andped10 andped10 commented Sep 9, 2024

The theme we use in Sphinx (sphinx-rtd-theme) needs to be a relative recent. This breaks the compatibility with the installed version of docutils.

When doing a forced upgrade the documentation builds and it look alright. My suggestion is therefore that we just ignore the issue as it will probably disappear when we become able to use a more up to date version of docutils

Different syntax adaptation to the new code structure.

@andped10 andped10 added [scope] bug Bug report or fix (major.minor.PATCH) [scope] documentation Documentation only changes (major.minor.patch.POST) labels Sep 9, 2024
Copy link
Member

@rozyczko rozyczko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
At some point we need to revisit the change and make sure docutils/spinx themes install normally, without us forcing the upgrade.

@andped10 andped10 merged commit a4324e3 into develop Sep 9, 2024
@andped10 andped10 deleted the 57-documentation-doesnt-build branch September 9, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[scope] bug Bug report or fix (major.minor.PATCH) [scope] documentation Documentation only changes (major.minor.patch.POST)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants