-
Notifications
You must be signed in to change notification settings - Fork 91
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
Add man pages. #490
Add man pages. #490
Conversation
Well, Travis fails on py 3.5 and the Gtihub greeting script too? 90% sure those aren't my fault :p |
The worlds needs more restructured text. Thanks for picking this up. |
You're right, thanks for the pull request!
Unfortunately this is a known issue, unrelated to your pull request: actions/first-interaction#10
Actually that is our CI job which checks for code issues (errors, PEP-8, etc.) using flake8. The issues reported here are real but unrelated to your pull request (it seems that the tool got updated and caught new issues). The errors should now be fixed in |
Hey @mruszczyk, it would be awesome to get these included in the Fedora RPM packages downstream for next release 😄 Btw thanks for packaging in Fedora! |
I still need to review and test this but it looks good. One little change I would like to see is adding a mention about the new dependency (docutils) to the README (optional dependencies section, I think) and a link to I may even add a new Travis CI job to detect future syntactic warnings/errors in the documentation files... Something like this should suffice: for manpage in *.rst; do rst2man --exit-status=2 --report=1 --debug ${manpage} "${manpage%%.*}".1 ; done |
@JoeLametta I'll let you play with Travis, as I have more experience with Gitlab CI. Fixed the other 2 things though. |
1e5c029
to
84a1d7c
Compare
Fixes whipper-team#73. Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
README Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I've rebased against develop
and did a few small changes.
Will leave the Travis CI thing out of this for the moment being. |
Merged, thanks! |
Here we go!
This should make #446 obsolete :)
Once the man pages are built, you can view them locally with: