docs: set man_make_section_directory to false #3750
Merged
Conversation
This file contains hidden or 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
And fix inconsistent manpage build paths between recent sphinx releases. False is the currently expected value, as setup.py will check for a built manpage in `docs/_build/man/streamlink.1` for inclusion in the release tarballs. Even though the doc's HTML theme "furo" does currently limit the used sphinx version to 3.x, this won't stop users building the manpage using sphinx 4.x, eg. via a global system-package.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
And fix inconsistent manpage build paths between recent sphinx
releases. False is the currently expected value, as setup.py
will check for a built manpage in
docs/_build/man/streamlink.1for inclusion in the release tarballs.
Even though the doc's HTML theme "furo" does currently limit the
used sphinx version to 3.x, this won't stop users building the
manpage using sphinx 4.x, eg. via a global system-package.
What a mess...
https://www.sphinx-doc.org/en/master/changes.html
Sphinx 4:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_make_section_directory
Sphinx 3:
https://www.sphinx-doc.org/en/3.x/usage/configuration.html#confval-man_make_section_directory