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.

Sign up for GitHub

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

Jump to bottom

add manpage #73

Closed
RecursiveForest opened this issue Nov 11, 2016 · 5 comments
Closed

add manpage #73

RecursiveForest opened this issue Nov 11, 2016 · 5 comments
Assignees
@MerlijnWajer
Labels
Accepted Accepted issue on our roadmap Feature New feature Needed: documentation Documentation is required Needed: patch A pull request is required Priority: medium Medium priority Sprintable Small enough to sprint on
Milestone
1.0

Comments

@RecursiveForest
Copy link
Contributor

What form this takes needs to come after we remove python-command.
@RecursiveForest RecursiveForest added this to the 1.0 milestone Nov 11, 2016
@MerlijnWajer
Copy link
Collaborator

The way I usually write manpages is by writing a document in restructured text, and then use rst2man. May be useful here as well?

@MerlijnWajer
Copy link
Collaborator

The nice thing with rst/sphinx is that you can also have it automatically include docstrings from your code.

@JoeLametta JoeLametta mentioned this issue Aug 29, 2017
Closed
@JoeLametta JoeLametta mentioned this issue Jan 6, 2018
Merged
@MerlijnWajer MerlijnWajer self-assigned this Jan 7, 2018
@MerlijnWajer
Copy link
Collaborator

I will take an initial stab at a makefile generated from a .rst file - if that's OK with everyone.

@RecursiveForest
Copy link
Contributor Author

RecursiveForest commented Mar 2, 2018 •
edited
Loading

I don't mind but I also don't see the problem with writing roff either. I say go for it, if the results are good then it'll be fine by me. I assume you meant "manpage" instead of "makefile" though.

@MerlijnWajer
Copy link
Collaborator

Right. I'll do this soon.

@MerlijnWajer MerlijnWajer mentioned this issue Sep 2, 2018
Open
@JoeLametta JoeLametta mentioned this issue Sep 25, 2018
Open
7 tasks
@JoeLametta JoeLametta mentioned this issue Nov 2, 2018
Open
@JoeLametta JoeLametta added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap Priority: high High priority Feature New feature Sprintable Small enough to sprint on Needed: patch A pull request is required and removed enhancement labels Nov 11, 2018
@JoeLametta JoeLametta added Priority: medium Medium priority and removed Priority: high High priority labels Dec 15, 2018
JoeLametta added a commit that referenced this issue Jan 6, 2020
@JoeLametta
WIP: Add manpage
a4fd28d 
This manpage is based on morituri's one (Debian version).
See: https://manpages.debian.org/jessie/morituri/rip.1

Fixes #73.

Signed-off-by: JoeLametta <JoeLametta@users.noreply.github.com>
@JoeLametta JoeLametta mentioned this issue Jan 6, 2020
Closed
@JoeLametta JoeLametta mentioned this issue Apr 23, 2020
Open
@baldurmen baldurmen mentioned this issue May 28, 2020
Closed
baldurmen added a commit to baldurmen/whipper that referenced this issue May 29, 2020
@baldurmen
Add man pages.
b69d28c 
Fixes whipper-team#73.

Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
JoeLametta pushed a commit to baldurmen/whipper that referenced this issue May 30, 2020
@baldurmen @JoeLametta
Add man pages.
e0955f9 
Fixes whipper-team#73.

Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
JoeLametta pushed a commit to baldurmen/whipper that referenced this issue May 30, 2020
@baldurmen @JoeLametta
Add man pages.
686e7d6 
Fixes whipper-team#73.

Signed-off-by: Louis-Philippe Véronneau <pollo@debian.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MerlijnWajer MerlijnWajer

Labels
Accepted Accepted issue on our roadmap Feature New feature Needed: documentation Documentation is required Needed: patch A pull request is required Priority: medium Medium priority Sprintable Small enough to sprint on
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

WIP: Add manpage whipper-team/whipper
3 participants
@RecursiveForest @MerlijnWajer @JoeLametta