Use the following command in a python virtual environment for a known working config:
# python3 -m pip install -r requirements.txt
OR you can use a docker container like the following:
$ git clone ssh://git@bitbucket.itg.ti.com/processor-sdk/processor-sdk-doc.git
$ make clean DEVFAMILY=<FAMILY> OS=linux
$ make config DEVFAMILY=<FAMILY> OS=linux
$ make DEVFAMILY=<FAMILY> OS=linux
$ make clean DEVFAMILY=<FAMILY> OS=rtos
$ make config DEVFAMILY=<FAMILY> OS=rtos
$ make DEVFAMILY=<FAMILY> OS=rtos
$ make clean DEVFAMILY=<FAMILY> OS=android
$ make config DEVFAMILY=<FAMILY> OS=android
$ make DEVFAMILY=<FAMILY> OS=android
$ make config DEVFAMILY=AM64X
$ make DEVFAMILY=AM64X
Note: that DEVFAMILY represents the Device Family.
Possible values for
Note: Please use script bin/check-warn.sh
or the make lint
target
to check for new build warnings and fix them before submitting
pull-requests.
Open the index page in a web browser
AM64X:
./build/processor-sdk-AM64X/esd/docs/[version]/index.html
GEN family (TODO: to be migrated to the new structure):
linux: ./build/processor-sdk-linux/esd/docs/[version]/index.html
rtos: ./build/processor-sdk-rtos/esd/docs/[version]/index.html
android: ./build/processor-sdk-android/esd/docs/[version]/index.html
Others:
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
rtos: ./build/processor-sdk-rtos-<FAMILY>/esd/docs/[version]/index.html
Add the following to your init.vim
to automatically use the standard
whitespace values for RST files:
autocmd FileType rst set tabstop=3 shiftwidth=3 expandtab