explain how to test the man page
This commit is contained in:
parent
b617257f0c
commit
6be61a26d0
10
README.md
10
README.md
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue