Update docs engine deps #854
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Thank you for contributing to the Leapp project!Please note that every PR needs to comply with the Leapp Guidelines and must pass all tests in order to be mergeable.
To launch regression testing public members of oamg organization can leave the following comment:
Please open ticket in case you experience technical problem with the CI. (RH internal only) Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please consider rerunning the CI by commenting leapp-ci build (might require several comments). If the problem persists, contact leapp-infra. |
matejmatuska
force-pushed
the
update-docs-deps
branch
3 times, most recently
from
9ae1adc
to
e65076a
Compare
|
/rerun |
The biggest changes is the replacement of recommonmark with MyST for markdown parsing. The recommonmark library is no longer maintained and is also deprecated in sphinx. The recommended replacement is MyST library. In our case it seems like a drop-in replacement with only errors being "non-consecutive header level increment", which shouldn't be a problem and the docs build successfully.
No major changes, just some deprecated APIs are replaced.
Instead of linking to autodoc generated HTML files (in the pydoc dir), use cross references. Also fix some of the ambiguous references and repair some of the broken ones.
No breaking changes. This version requires Python 3.10 for deps to correctly install, otherwise the version of sphinx-autobuild and sphinxcontrib-* packages would have to pinned.
No breaking changes. Works properly on Python >= 3.10. On Python 3.12 requires manual upgrade of the six package until the version is bumped in requirements.txt.
matejmatuska
force-pushed
the
update-docs-deps
branch
from
e65076a
to
2767aa7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The the previously used version of the docs engine (sphinx) was very old and long unmaintained.
Going with version 7.2.6, which requires Python 3.10, because it's relatively recent (released Sep 13, 2023), also works on Python 3.12 and all the features we need are there.
The 3.12 requires manually update of the six package until the version is bumped in requirements.txt.
NOTE: There is still a bunch of warnings, however those don't seem to affect the docs in any way and the documentation is going to be refactored in the near future.