Skip to content

Commit fa97ff6

Browse files
committed
docs(README): Updates README commands
Moves git clone section above install tools. Updates two install tool versions that were broken. Signed-off-by: Jonas Wood <[email protected]>
1 parent 10ceaf6 commit fa97ff6

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,24 @@ Processor SDK Documentation in Sphinx
33

44
## Instructions to build the project on Ubuntu
55

6+
### Clone the Git Repo
7+
8+
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
9+
610
### Install tools on Ubuntu
711

812
Use the following command in a python virtual environment for a known working
913
config:
1014

11-
# python3 -m pip install -r requirements.txt
15+
$ cd processor-sdk-doc
16+
$ python3 -m pip install -r requirements.txt
17+
18+
> [!WARNING]
19+
> This is supported using Python v3.12/3.13. If you use a different Python version, some package versions in `requirements.txt` may not be compatible.
1220
1321
OR you can use a docker container like the following:
1422
- [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc)
1523

16-
### Clone the Git Repo
17-
18-
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
19-
2024
### Build on Ubuntu
2125

2226
To build the documentation a DEVFAMILY and OS must be specified as either an
@@ -51,23 +55,23 @@ Example build commands:
5155

5256
- Build linux documentation for AM335X
5357

54-
$ make DEVFAMILY=AM335X OS=linux
58+
$ make DEVFAMILY=AM335X OS=linux
5559

5660
- Build android documentation for AM62X
5761

58-
$ make DEVFAMILY=AM62X OS=android
62+
$ make DEVFAMILY=AM62X OS=android
5963

6064
- Build debian documentation for AM62PX
6165

62-
$ make DEVFAMILY=AM62PX OS=debian
66+
$ make DEVFAMILY=AM62PX OS=debian
6367

6468
### HTML Page Output
6569

6670
Open the index page in a web browser
6771

6872
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
6973
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
70-
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
74+
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
7175

7276
## Live Preview on GitHub Pages
7377

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ requests==2.32.3
2020
rich==13.9.4
2121
roman-numerals-py==3.1.0
2222
rstcheck==6.2.4
23-
rstcheck-core @ git+https://github.com/StaticRocket/rstcheck-core.git@b7bdfd920a023e24ffe5e560c706954656c366f0
23+
rstcheck-core==1.2.1
2424
shellingham==1.5.4
2525
snowballstemmer==2.2.0
2626
Sphinx==8.2.3

0 commit comments

Comments
 (0)