@@ -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
812Use the following command in a python virtual environment for a known working
913config:
1014
11- # python3 -m pip install -r requirements.txt
15+ $ cd processor-sdk-doc
16+ $ python3 -m pip install -r requirements.txt
1217
1318OR 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
2223To build the documentation a DEVFAMILY and OS must be specified as either an
@@ -51,23 +52,23 @@ Example build commands:
5152
5253 - Build linux documentation for AM335X
5354
54- $ make DEVFAMILY=AM335X OS=linux
55+ $ make DEVFAMILY=AM335X OS=linux
5556
5657 - Build android documentation for AM62X
5758
58- $ make DEVFAMILY=AM62X OS=android
59+ $ make DEVFAMILY=AM62X OS=android
5960
6061 - Build debian documentation for AM62PX
6162
62- $ make DEVFAMILY=AM62PX OS=debian
63+ $ make DEVFAMILY=AM62PX OS=debian
6364
6465### HTML Page Output
6566
6667Open the index page in a web browser
6768
6869 linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
6970 android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
70- debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
71+ debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
7172
7273## Live Preview on GitHub Pages
7374
@@ -78,4 +79,4 @@ preview will be available on GitHub Pages immediately.
7879You can access the latest bleeding-edge documentation at the following link:
7980 - [ Processor SDK Documentation] ( https://texasinstruments.github.io/processor-sdk-doc/ )
8081
81- Please treat GitHub Pages as the most up-to-date source of documentation.
82+ Please treat GitHub Pages as the most up-to-date source of documentation.
0 commit comments