Skip to content

Commit 13bd694

Browse files
committed
docs(readme): simplify the readme and example make
At this point we should drive users to the container properly. That gives them access to almost all of the CI tools and ensures the output they generate will match what we expect. Advanced users can still parse the requirements.txt if they want. Also, add an example make command using the container to the top of the build guide since that is one of the more popular things I need to remind people about. Signed-off-by: Randolph Sapp <rs@ti.com>
1 parent 030e4ef commit 13bd694

File tree

1 file changed

+61
-73
lines changed

1 file changed

+61
-73
lines changed

README.md

Lines changed: 61 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,83 @@
1-
Processor SDK Documentation in Sphinx
2-
=====================================
1+
# Processor SDK documentation
32

4-
## Instructions to build the project on Ubuntu
3+
This is the documentation for the Texas Instruments Processor Software
4+
Development Kit (PSDK). It uses Sphinx and reStructuredText. There are some
5+
light plugins and a custom configuration tool to handle device specific values.
56

6-
### Clone the Git Repo
7+
## Build guide
78

8-
$ git clone https://github.com/TexasInstruments/processor-sdk-doc.git
9+
Continue reading if you have any questions about the following command.
910

10-
### Install tools on Ubuntu
11+
```
12+
docker run -it --rm -v "$PWD":/build ghcr.io/texasinstruments/processor-sdk-doc:latest make DEVFAMILY=AM62X OS=linux
13+
```
1114

12-
Use the following command in a python virtual environment for a known working
13-
config:
15+
### Clone the repository
1416

15-
$ cd processor-sdk-doc
16-
$ python3 -m pip install -r requirements.txt
17+
```
18+
git clone https://github.com/TexasInstruments/processor-sdk-doc.git
19+
```
1720

18-
> [!WARNING]
19-
> This is supported using Python v3.12+. If using an older Python version, some package versions in `requirements.txt` may not be compatible, possibly due to an older
20-
> bundled `pip` version.
21+
### Start the container
2122

22-
OR you can use a docker container like the following:
23-
- [psdk-doc-docker](https://github.com/TexasInstruments/processor-sdk-doc/pkgs/container/processor-sdk-doc)
23+
A small container with all required tools is available on the GitHub. The source
24+
is in the [`docker/`](docker/) subdirectory.
2425

25-
### Build on Ubuntu
26+
To start the container, issue the following at the root of the project.
2627

27-
To build the documentation a DEVFAMILY and OS must be specified as either an
28-
argument to `make` or set as environment variables prior to execution of `make`.
28+
```
29+
docker run -it --rm -v "$PWD":/build ghcr.io/texasinstruments/processor-sdk-doc:latest
30+
```
2931

30-
DEVFAMILY represents the Device Family. Possible values correspond to the names
31-
of directories listed under `configs/`. For example:
32+
### Issue make
3233

33-
* "AM335X" (representing AM335X family)
34-
* "AM437X" (representing AM437X family)
35-
* "AM57X" (representing AM57X family)
36-
* "AM64X" (representing AM64X family)
37-
* "AM62X" (representing AM62X family)
38-
* "AM62AX" (representing AM62AX family)
39-
* "AM62PX" (representing AM62PX family)
40-
* "AM62LX" (representing AM62L family)
41-
* "AM62DX" (representing AM62D family)
42-
* "AM65X" (representing AM65X family)
43-
* "DRA821A" (representing DRA821A)
44-
* "J721E" (representing Jacinto 7 ES)
45-
* "J7200" (representing Jacinto 7 VCL)
46-
* "J721S2" (representing Jacinto 7 AEP)
47-
* "J784S4" (representing Jacinto 7 AHP)
48-
* "J722S" (representing Jacinto 7 AEN)
34+
GNU Make handles some initial setup. Specify the `DEVFAMILY` and `OS` values as
35+
either arguments to `make` or as environment variables.
4936

50-
OS represents the operating system. Possible values correspond to the second
51-
parameter of files listed under the `configs/<DEVFAMILY>/` directory. For
52-
example `AM57X_linux_toc.txt` means that `linux` is a valid OS value.
37+
`DEVFAMILY` stands for the Device Family. Possible values correspond to the
38+
names of directories listed under [`configs/`](configs/).
5339

54-
Example build commands:
55-
56-
- Build linux documentation for AM335X
57-
58-
$ make DEVFAMILY=AM335X OS=linux
59-
60-
- Build android documentation for AM62X
61-
62-
$ make DEVFAMILY=AM62X OS=android
63-
64-
- Build debian documentation for AM62PX
40+
`OS` stands for the operating system. Possible values correspond to the second
41+
part of files listed under the `configs/<DEVFAMILY>/` directory. For example
42+
`AM57X_linux_toc.txt` means that `linux` is a valid `OS` value.
6543

66-
$ make DEVFAMILY=AM62PX OS=debian
67-
68-
- Build EdgeAI documentation for AM62AX
69-
70-
$ make DEVFAMILY=AM62AX OS=edgeai
71-
72-
### HTML Page Output
73-
74-
Open the index page in a web browser
44+
Example build commands:
7545

76-
linux: ./build/processor-sdk-linux-<FAMILY>/esd/docs/[version]/index.html
77-
android: ./build/processor-sdk-android-<FAMILY>/esd/docs/[version]/index.html
78-
debian: ./build/processor-sdk-debian-<FAMILY>/esd/docs/[version]/index.html
79-
edgeai: ./build/processor-sdk-edgeai-<FAMILY>/esd/docs/[version]/index.html
46+
- Build Linux documentation for AM335X
47+
```
48+
make DEVFAMILY=AM335X OS=linux
49+
```
50+
- Build Android documentation for AM62X
51+
```
52+
make DEVFAMILY=AM62X OS=android
53+
```
54+
- Build Debian documentation for AM62PX
55+
```
56+
make DEVFAMILY=AM62PX OS=debian
57+
```
58+
- Build EdgeAI documentation for AM62AX
59+
```
60+
make DEVFAMILY=AM62AX OS=edgeai
61+
```
62+
63+
### Document output
64+
65+
Currently only HTML output is supported. The output is available in directories
66+
matching the following template on a successful build:
67+
68+
```
69+
./build/processor-sdk-<OS>-<DEVFAMILY>/esd/docs/<VERSION>/index.html
70+
```
8071
8172
## Contributing
8273
83-
See the [contribution guidelines](CONTRIBUTING.md) for information about
84-
formatting guidelines, workflows, and common issues.
85-
86-
## Live Preview on GitHub Pages
74+
See [CONTRIBUTING.md](CONTRIBUTING.md) for information about formatting,
75+
workflows, and common issues.
8776
88-
GitHub Pages are now live for all `DEVFAMILY` and `OS` supported by this repository.
89-
This means that for every pull request merged into the master branch, an equivalent
90-
preview will be available on GitHub Pages immediately.
77+
## Development previews through GitHub Pages
9178
92-
You can access the latest bleeding-edge documentation at the following link:
93-
- [Processor SDK Documentation](https://texasinstruments.github.io/processor-sdk-doc/)
79+
GitHub Pages are now live for all `DEVFAMILY` and `OS` supported by this
80+
project. This means that the current `master` build is on GitHub
81+
Pages at the following link.
9482
95-
Please treat GitHub Pages as the most up-to-date source of documentation.
83+
https://texasinstruments.github.io/processor-sdk-doc/

0 commit comments

Comments
 (0)