| Line | |
|---|
| 1 | WLAN Exp Documentation |
|---|
| 2 | |
|---|
| 3 | HTML documentation for the WLAN Experiments framework is generated directly from |
|---|
| 4 | the source code documentation using Sphinx. |
|---|
| 5 | |
|---|
| 6 | Requirements: |
|---|
| 7 | - Sphinx v1.2.3 (and any dependencies) |
|---|
| 8 | - make |
|---|
| 9 | |
|---|
| 10 | How to build: |
|---|
| 11 | - For a WLAN Exp installation in: |
|---|
| 12 | <installation directory>\Mango_802.11_RefDes_v<version>\Python_Reference |
|---|
| 13 | where <version> is the version of the reference design, e.g. 1.5.3, and the |
|---|
| 14 | <installation directory> is where the 802.11 reference design was unzipped. |
|---|
| 15 | This directory will be referred to below as <WLAN_EXP_BASE_DIR>. |
|---|
| 16 | |
|---|
| 17 | - In a terminal that supports make (such as a Cygwin Terminal), run: |
|---|
| 18 | cd <WLAN_EXP_BASE_DIR>/wlan_exp/docs |
|---|
| 19 | PYTHONPATH=<WLAN_EXP_BASE_DIR> make html |
|---|
| 20 | |
|---|
| 21 | - Use your preferred web browser to open the documentation in: |
|---|
| 22 | <WLAN_EXP_BASE_DIR>/wlan_exp/docs/build/html/index.html |
|---|
| 23 | |
|---|
Note: See
TracBrowser
for help on using the repository browser.
