https://github.com/synbiodex/sboltutorial
sbol tutorial(s) on readTheDocs
https://github.com/synbiodex/sboltutorial
Last synced: 5 months ago
JSON representation
sbol tutorial(s) on readTheDocs
- Host: GitHub
- URL: https://github.com/synbiodex/sboltutorial
- Owner: SynBioDex
- License: apache-2.0
- Created: 2016-04-14T15:48:31.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-15T15:49:09.000Z (about 10 years ago)
- Last Synced: 2025-06-19T06:42:41.750Z (12 months ago)
- Size: 20.5 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SBOL Tutorial

####SBOL tutorial(s) on [readTheDocs.org](http://rtd.org)
The actual tutorial page can be found here: http://sboltutorial.readthedocs.org
Any modifications to the github repository (master) will automatically trigger recompilation of the html on readthedocs.org.
For local compiling, you need [Sphinx](http://sphinx-doc.org/). Once this is in place:
```sh
cd docs
make html
```
This will create a new HTML tree in `docs/_build` which you can browse by
pointing your web browser to `index.html`
### Syntax
Doc files can either be in reStructuredText (.rst) or markdown (.md) format. reStructuredText has many more formatting options and is the only format for creating table of contents. However, markdown is somewhat easier to read / edit so it should perhaps be used for "end documents".
Further reading:
* [ReadTheDocs getting started](http://docs.readthedocs.org/en/latest/getting_started.html)
### Contribute!
Please fork this repository, add / edit the documentation and send back a pull request.
## License
released under the Apache 2.0 [license](./LICENSE).