Fix the warnings of the documentation build - #218
Open
gdevenyi wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Remove the stale MANDIR prerequisite from the argbash.5 target.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This pull request updates documentation build configuration to remove Sphinx warnings and clean up Makefile rules.
Changes:
- Sets Sphinx language explicitly to
en. - Removes the obsolete
MANDIRdirectory rule. - Leaves a stale
MANDIRprerequisite onargbash.5.
File summaries
| File | Summary |
|---|---|
doc/Makefile |
Removes the obsolete directory rule; retains a stale prerequisite. |
doc/conf.py |
Sets the Sphinx language to en. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| argbash.1: argbash.rst | ||
| grep -v ':ref:' $< | sed -e 's/^\.\.\s\+code-block.*/::/' | rst2man > $@ | ||
|
|
||
| argbash.5: config.rst | $(MANDIR) |
Author
There was a problem hiding this comment.
Done, the argbash.5 target lost its MANDIR prerequisite as well.
- Sphinx no longer accepts 'language = None', it warns and falls back to English; say 'en' explicitly. - doc/Makefile defined the 'man' target twice: as the Sphinx manpage build and as a directory that nothing used. Drop the directory. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017DxhC3HmTM7TQUzkBZnyH2
gdevenyi
force-pushed
the
docs/sphinx-warnings
branch
from
September 13, 2026 02:20
bbeb398 to
6e7bbec
Compare
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
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.
make htmlindoc/printed two warnings:language = Noneinconf.py(it warns and falls back to English); sayenexplicitly.doc/Makefiledefined themantarget twice: once as the Sphinx manpage build and once as a directory (MANDIR = man) that nothing used. The directory rule is dropped.The build is warning-free afterwards.
🤖 Generated with Claude Code
https://claude.ai/code/session_017DxhC3HmTM7TQUzkBZnyH2