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

Pin the Sphinx version and update the docs theme #3087

Merged
merged 1 commit into from
Jul 16, 2024
Merged

Pin the Sphinx version and update the docs theme #3087

merged 1 commit into from
Jul 16, 2024

Conversation

psss
Copy link
Collaborator

@psss psss commented Jul 16, 2024

Seems that the latest docutils-0.21.2 do not include the rst2man.py command any more which broke package and docs building. Let's pin the sphinx version which is compatible with our theme.

Pull Request Checklist

  • implement the feature

@psss psss added documentation Improvements or additions to documentation packaging labels Jul 16, 2024
@psss psss added this to the 1.35 milestone Jul 16, 2024
@psss psss added the status | blocking other work An important pull request, blocking other pull requests or issues label Jul 16, 2024
@psss
Copy link
Collaborator Author

psss commented Jul 16, 2024

For reference, the rpm build error was this:

2024-07-16 06:51:16.697 logging.py        INFO   cmd [1] | cp /tmp/tmpibff8i6r/docs/header.txt /tmp/tmpibff8i6r/man.rst
2024-07-16 06:51:16.699 logging.py        INFO   cmd [2] | tail -n+8 docs/overview.rst >> /tmp/tmpibff8i6r/man.rst
2024-07-16 06:51:16.702 logging.py        INFO   cmd [3] | sed '/versionadded::/d' -i /tmp/tmpibff8i6r/man.rst
2024-07-16 06:51:16.705 logging.py        INFO   cmd [4] | rst2man.py /tmp/tmpibff8i6r/man.rst > /tmp/tmpibff8i6r/tmt.1
2024-07-16 06:51:16.707 logging.py        INFO   /bin/sh: line 1: rst2man.py: command not found

And here's one of the jobs.

@psss psss changed the title Use the rst2man command to prepare the man page Pin the Sphinx version and update the docs theme Jul 16, 2024
Copy link
Collaborator

@martinhoyer martinhoyer left a comment

Choose a reason for hiding this comment

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

Could have just used the 2b9d4ea commit, but I'm happy not to be in the danger of being git blamed :D

@psss psss self-assigned this Jul 16, 2024
@psss psss merged commit 8768c83 into main Jul 16, 2024
11 of 19 checks passed
@psss psss deleted the fresh-docutils branch July 16, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation packaging status | blocking other work An important pull request, blocking other pull requests or issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants