Skip to content

Commit 250a8c8

Browse files
committed
docs(README): Updates README Commands
Moves git clone section before install tools. Updates pip install tool versions. Signed-off-by: Jonas Wood <[email protected]>
1 parent 6dc42e6 commit 250a8c8

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,21 @@ 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
1217

1318
OR you can use a docker container like the following:
1419
- [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc)
1520

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

2223
To build the documentation a DEVFAMILY and OS must be specified as either an
@@ -65,9 +66,9 @@ Example build commands:
6566

6667
Open the index page in a web browser
6768

68-
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
69-
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
70-
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
69+
linux: open ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
70+
android: open ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
71+
debian: open ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
7172

7273
## Live Preview on GitHub Pages
7374

requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ 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
26-
Sphinx==8.2.3
26+
Sphinx==8.1.3
2727
sphinx-copybutton==0.5.2
2828
sphinx-rtd-theme==3.0.2
2929
sphinx-tabs==3.4.7
@@ -36,4 +36,4 @@ sphinxcontrib-qthelp==2.0.0
3636
sphinxcontrib-serializinghtml==2.0.0
3737
typer==0.15.2
3838
typing_extensions==4.12.2
39-
urllib3==2.3.0
39+
urllib3==2.3.0

0 commit comments

Comments
 (0)