https://github.com/badbye/autotest-docs
Document for autotest packages
https://github.com/badbye/autotest-docs
Last synced: about 2 months ago
JSON representation
Document for autotest packages
- Host: GitHub
- URL: https://github.com/badbye/autotest-docs
- Owner: badbye
- Created: 2017-02-06T05:33:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-17T02:33:34.000Z (over 8 years ago)
- Last Synced: 2025-02-14T15:17:30.178Z (3 months ago)
- Language: Python
- Size: 202 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Document For autotest
Online: [http://autotest-docs.readthedocs.io/](http://autotest-docs.readthedocs.io/)
## Edit
The documents of R locate at the `source/R` folder, while the documents of Python locates at the `source/Python` folder.
The documents are using `reStructuredText` format, which is very similar to Markdown but more powerful. Read this [tutorial](http://sphinx-doc-zh.readthedocs.io/en/latest/rest.html) to learn reStructuredText.
## Setup
Setup locally:
```bash
sudo pip install sphinx sphinx-autobuild
make html # build, it will generate a `build` folder
cd build/html && python -m SimpleHTTPServer # open http://localhost:8000/ in Chrome
```
After pushing to Github, the [online document](http://autotest-docs.readthedocs.io/) will update automatically.