explain how to test the man page

This commit is contained in:
Abraham Toriz 2022-09-20 10:52:42 -04:00
parent b617257f0c
commit 6be61a26d0
No known key found for this signature in database
GPG Key ID: D5B4A746DB5DD42A
1 changed files with 7 additions and 3 deletions

View File

@ -112,9 +112,13 @@ for the html version (output located at `docs/build/html`), or
make man
for the man page (output located at `docs/build/man/tiempo.1`). If you
are using pipenv just prefix the commands with `pipenv run` or run `pipenv
shell` before running any command.
for the man page (output located at `docs/build/man/tiempo.1`). To test the man
page you can do:
man -l docs/build/man/tiempo.1
If you are using pipenv to build the docs just prefix the commands with `pipenv
run` or run `pipenv shell` before running any command.
The contents of the docs are located in `docs/source/index.rst`,
formatted as