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

Warnings in sphinx generated manpage #171

Open
ghisvail opened this issue Jul 7, 2016 · 0 comments
Open

Warnings in sphinx generated manpage #171

ghisvail opened this issue Jul 7, 2016 · 0 comments

Comments

@ghisvail
Copy link
Contributor

ghisvail commented Jul 7, 2016

The manpage for hdfcompass produced by:

sphinx-build -N -b man docs build/man

has formatting warnings according to the Debian linting tool.

It uses the output of the following command:

MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z ./build/man/hdfcompass.1 >/dev/null
<standard input>:113: warning [p 2, 2.0i]: cannot adjust line
<standard input>:120: warning [p 2, 3.7i]: can't break line
<standard input>:148: warning [p 2, 8.0i]: can't break line
<standard input>:161: warning [p 2, 10.3i]: cannot adjust line

which lists 4 warnings.

I understand that the content of the documentation is still work-in-progress, so fixing this issue may be considered low-priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant