From a0a8ad2689f4087313201bfaf794a138c30d0e4f Mon Sep 17 00:00:00 2001 From: Storm Date: Wed, 19 Nov 2025 17:59:37 +0100 Subject: [PATCH] docs: changed readme ref: N25B-270 --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index badd3f2..8bde763 100644 --- a/README.md +++ b/README.md @@ -150,21 +150,26 @@ commit name != : description of the commit. ## Documentation Generate documentation web pages using: +### Linux & macOS ```bash PYTHONPATH=src sphinx-apidoc -F -o docs src/robot_interface ``` +### Windows +```bash +$env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/control_backend +``` + Optionally, in the `conf.py` file in the new `docs` folder, change preferences. -For the page theme, change `html_theme` to `'sphinx_rtd_theme'`. In the `docs` folder: +### Linux & macOS +```bash +make html +``` + ### Windows ```bash .\make.bat html -``` - -### MacOS -```bash -make html ``` \ No newline at end of file