aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJose Castillo <jcastillo@redhat.com>2023-12-02 21:01:41 +0000
committerJake Hunsaker <jacob.r.hunsaker@gmail.com>2023-12-13 18:20:57 -0500
commit36d9e095787a3e803afbbaa7031c347c8cf7c2d1 (patch)
treeda272c3c645a2c539897b32e40407016e95c1997 /README.md
parent102d9cb161e85ca121c165a604611b1c8eac1e62 (diff)
downloadsos-36d9e095787a3e803afbbaa7031c347c8cf7c2d1.tar.gz
[doc] Update README.md with new way to generate html docs
Commit ac17ca4f4 removed the command build_sphinx from setup.py, but the README.md file still references it. This patch offers an alternative for uses wishing to generate html docs, using the command sphinx-build. Related: RH: RHEL-17924 Signed-off-by: Jose Castillo <jcastillo@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 70db0b63..00ed176f 100644
--- a/README.md
+++ b/README.md
@@ -83,7 +83,7 @@ pip install -r requirements.txt
and run
```
-python3 setup.py build_sphinx -a
+sphinx-build -b html docs <destination dir>
```