Add man papis and other manpage improvements#1126
Conversation
WIP:
- Make the entry point papis(1) more like a typical introduction
manpage
- Maybe mimic the relevant parts in git(1)?
man papis and other manpage improvements
There'a already a
I'm definitely in favor of that! Using
It's also easier to just have separate files for each one 😁 I would prefer that + a nice EDIT: Was looking at |
|
Oops sorry for wiping the message, I was about to move the todos around. I edited all of them back 😄 |
Yeah, it kind of does :( I've never played with Sphinx manpage generation though, so I'm not sure how much of that can be styled differently. If you make any progress, that would be amazing! 😁 EDIT: The styling might also come from |
|
Always happy to see work on the docs ❤️! More than happy to help with this!
What do you mean by this? That we'd have to write a page detailing how to find all the subcommand specific pages? That doesn't seem so bad to me... |
Yeah, agreed, that doesn't seem too bad.. it would just be a one time thing. Maybe we can even automate it somehow using a special directive + some magic in |
|
Yep I was just saying if we want the list of commands to double as refs to their manpages:
Only makes sense in the manpage version But that was just inspiration from the git manpage, those refs can be on a separate list also But yeah it's just that one word/representation that has to vary that's true But this is thinking a bit too far ahead 😄
With this approach, they could just be generated into the Or a general note saying "The subcommands man pages are in |



Draft for #1096
Motivation
papis(1)doesn't exist, which easily makes it seem there are no manpagesman 5 papisinstead ofman papis-config-settingsTodos/notes
I think it would be best to rework
papis-default(1)intopapis(1)Could take example from
git(1)Or have essentially the
papis --helpmessage but in manpage form with additional linkages to other pages?To be investigated:
#1096 (comment)
If there are many pages that could go into section 7, should they be combined into one?
Edit: probably not, look at how git does the section 7 pages:
I think adding a
SEE ALSOsection at the bottom just like that would be great, with also thepapis(5)(config page) mentioned there.