From 6be61a26d0f200a1e398b564a54b88c97efa3b12 Mon Sep 17 00:00:00 2001 From: Abraham Toriz Date: Tue, 20 Sep 2022 10:52:42 -0400 Subject: [PATCH] explain how to test the man page --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50967df..63271a1 100644 --- a/README.md +++ b/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