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

Create manpage and distribute with the software #72

Open
ryukinix opened this issue Nov 4, 2017 · 4 comments
Open

Create manpage and distribute with the software #72

ryukinix opened this issue Nov 4, 2017 · 4 comments

Comments

@ryukinix
Copy link
Owner

ryukinix commented Nov 4, 2017

Seems we can generate manpages with the sphinx docs (which can be improved). Would be nice getting this manpage and embedding on the package to get installed via pip or another package managers (like the package hosted on AUR)

@kutsan
Copy link

kutsan commented Dec 25, 2017

What about pandoc?

@ryukinix
Copy link
Owner Author

ryukinix commented Dec 25, 2017

I know pandoc and already use for some things (markdown -> rst for the pypi pages), but I didn't thought before that we can use pandoc for that too... Well, my thing with this is getting a automatized way to setup this without more managing things. Sphinx is great to deal and they generate manpages. But the biggest problem is: how we package this feature to be installed as a pip package? I don't know how to do that (yet).

@kutsan
Copy link

kutsan commented Dec 25, 2017

I guess by saying that, you are mentioning generating man pages on user installs other than manually pushing generated man page to master?

I bet you already know but ranger handles that good.

@ryukinix
Copy link
Owner Author

ryukinix commented Dec 25, 2017

Generating man pages on the process of PUBLISHING the package would nice. As I do by generating the correct rst formatted README for the pypi page. The main idea is have a easy way to edit the manpage as source (like a markdown) and generating a manpage-formatted file on setup.py and packing that file with the the package itself.

When a user install the mal package -- by pip or whatever be -- I would expect that the manpage of mal would be installed as well.

@ryukinix ryukinix added this to the v0.4 milestone Dec 31, 2017
@ryukinix ryukinix removed this from the v0.4.0 milestone Sep 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants