search

ryukinix / mal

MAL: A MyAnimeList Command Line Interface [BROKEN: BLAME MyAnimeList]
https://mal.readthedocs.io
Other
109 stars 9 forks source link

Create manpage and distribute with the software #72

Open ryukinix opened 6 years ago

ryukinix commented 6 years ago

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 commented 6 years ago

What about pandoc?

ryukinix commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

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.