retire custom manpage generator #796
Merged
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
|
Hi @elliefm your PR is missing a signoff as required for the DCO :) |
|
Oh right, I forgot you guys were using those, my bad! |
based on similar commit to cyrus-imapd: cyrusimap/cyrus-imapd@3867608 Signed-off-by: ellie timoney <[email protected]>
Signed-off-by: ellie timoney <[email protected]>
elliefm
force-pushed
the
retire-custom-manpage-generator
branch
from
5d45294
to
05e8c4f
Compare
|
Rebased with signoffs and forced-pushed :) |
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.
For some unknown historical reason, our documentation build uses a custom manpage generator, rather than the stock one provided by Sphinx. It keeps getting broken by incompatible new Sphinx versions.
This PR switches the docs build to use the stock manpage generator, and then removes the parts we're no longer using.
Equivalent changes were already landed for cyrus-imapd as cyrusimap/cyrus-imapd#4561
Reviewers: Two paths to test, each starting from a clean repository, and assuming you have all the prereqs for building the docs:
autoreconf -i -s && ./configure && make man=> lots of warnings (that were already there, and which I'm not trying to address), but should succeed. Produces man pages inman/, which can be viewed by e.g.man man/sasl_callbacks.3. Check that they're not empty files and are formatted okay.make -C docsrc man=> different output, same warnings, should succeed. Produces man pages indocsrc/build/man, verify as above.