tldr-pages / tldr-python-client

Python command-line client for tldr pages
https://pypi.org/project/tldr/
MIT License
596 stars 93 forks source link

Generate manpage with sphinx and add it to package #165

Closed dadav closed 2 years ago

dadav commented 2 years ago

This commit addresses issue #162 which suggested to add a manpage to the tldr python client. The changes in the tldr.py file where necessary, because sphinx needs an easy way to obtain the Argparser-object. I also added a Makefile, so the manpage can easily recreated.

You need the sphinx-build tool and the argparse extension. Both can usually installed via. your package-manager. In my case the packages where called python-sphinx and python-sphinx-argparse.

Closes #162

dadav commented 2 years ago

Sphinx apparently needs the runtime dependencies to be installed. For an easy way to install them and to prevent duplication, I put them in the requirements.txt... If this is not wanted, just tell me :)

MasterOdin commented 2 years ago

Thanks again for your contribution!