Skip to content

Commit 4ac85df

Browse files
committed
Update build instructions
1 parent 74fa79d commit 4ac85df

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

doc/readme.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The Sphinx Book Theme, Sphinx, and reStructuredText are all well documented. The
1717
* Python
1818
* A virtual environment like `venv` or `conda` (recommended)
1919
* Python packages listed in `requirements.txt`
20-
* Make
20+
* Make (optional)
2121
* A good text editor that can open a folder as a workspace and has syntax highlighting for reStructuredText (VS Code works well)
2222

2323
Tested on Windows with Python 3.12.10 and GNU Make 4.4.1.
@@ -42,13 +42,33 @@ Tested on Windows with Python 3.12.10 and GNU Make 4.4.1.
4242
path/to/sam-help-venv/Scripts/activate
4343
```
4444

45-
3. Run Make.
45+
3. Build Help from the `path/to/sam_dev/SAM/doc` folder.
46+
47+
```
48+
sphinx-build -M html source build
49+
```
50+
51+
If there are changes to table of contents or other structural changes, clean the build first:
52+
53+
Windows:
54+
55+
```
56+
rmdir /s /q build
57+
```
58+
59+
Mac or Linux:
60+
61+
```
62+
rm -rf build
63+
```
64+
65+
As an alternative, run Make, assuming Make is installed and `Makefile` is in the `doc` folder.
4666

4767
```
4868
make html
4969
```
5070

51-
To clean the build first, run `make clean`.
71+
To clean the build using Make, run `make clean`.
5272

5373
4. If there are any build errors, fix them by editing the appropriate .rst file(s).
5474

0 commit comments

Comments
 (0)