| Joey Armstrong | 2cab6b4 | 2022-09-08 12:59:42 -0400 | [diff] [blame^] | 1 | Modify docs.voltha.org |
| 2 | ====================== |
| 3 | |
| 4 | Docs for VOLTHA can be found on the website or via web search: |
| 5 | |
| 6 | - https://docs.voltha.org |
| 7 | - https://docs.voltha.org/master/index.html |
| 8 | |
| 9 | - Note: Google search may return an older doc version for topics. |
| 10 | - Navigate to /master/index.html and use the builtin searchbox to always view current documentation for VOLTHA. |
| 11 | |
| 12 | Browse repository content: |
| 13 | |
| 14 | - https://gerrit.opencord.org/plugins/gitiles/voltha-docs |
| 15 | |
| 16 | Checkout, modify and test: |
| 17 | |
| 18 | .. sourcecode:: shell |
| 19 | |
| 20 | $ git clone ssh://gerrit.opencord.org:29418/voltha-docs |
| 21 | |
| 22 | $ cd voltha-docs |
| 23 | $ vi *.rst |
| 24 | $ make html # doc generation |
| 25 | $ make test # syntax check *.rst files |
| 26 | |
| 27 | $ "$BROWSER" _build/html/index.html # BROWSER='firefox' |