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

Add man pages. #490

Merged
merged 2 commits into from
May 30, 2020
Merged

Add man pages. #490

merged 2 commits into from
May 30, 2020

Conversation

baldurmen
Copy link
Contributor

Here we go!

This should make #446 obsolete :)

Once the man pages are built, you can view them locally with:

man ./whipper.1

@baldurmen
Copy link
Contributor Author

Well, Travis fails on py 3.5 and the Gtihub greeting script too? 90% sure those aren't my fault :p

@MerlijnWajer
Copy link
Collaborator

The worlds needs more restructured text. Thanks for picking this up.

@JoeLametta
Copy link
Collaborator

Well, Travis fails on py 3.5 and the Gtihub greeting script too? 90% sure those aren't my fault :p

You're right, thanks for the pull request!

Gtihub greeting script too

Unfortunately this is a known issue, unrelated to your pull request: actions/first-interaction#10

Well, Travis fails on py 3.5

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 develop (commit 752162a).

@jwflory
Copy link

jwflory commented May 29, 2020

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!

@JoeLametta
Copy link
Collaborator

JoeLametta commented May 29, 2020

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 man/README.md. 😉

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

@baldurmen
Copy link
Contributor Author

@JoeLametta I'll let you play with Travis, as I have more experience with Gitlab CI. Fixed the other 2 things though.

@JoeLametta JoeLametta mentioned this pull request May 30, 2020
@JoeLametta JoeLametta force-pushed the manpages branch 2 times, most recently from 1e5c029 to 84a1d7c Compare May 30, 2020 10:29
baldurmen added 2 commits May 30, 2020 10:49
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>
Copy link
Collaborator

@JoeLametta JoeLametta left a 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.

@JoeLametta
Copy link
Collaborator

JoeLametta commented May 30, 2020

Will leave the Travis CI thing out of this for the moment being.

@JoeLametta JoeLametta merged commit e685c04 into whipper-team:develop May 30, 2020
@JoeLametta
Copy link
Collaborator

Merged, thanks!

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

Successfully merging this pull request may close these issues.

4 participants