tk/Ocelot
1
0
Fork 0
mirror of https://github.com/nsnail/Ocelot.git synced 2025-06-19 16:48:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Feature/docs (#165)

Browse Source 
* initial readthedocs commit

* docs moved to sphinx / rst / read the docs
This commit is contained in:
Tom Pallister
2017-11-25 15:03:50 +00:00
committed by GitHub
parent 48b5a32676
commit 923276651d
29 changed files with 1973 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/readme.md Normal file
View File

@ -0,0 +1,14 @@
# Ocelot documentation
The folder contains the documentation for Ocelot.
We are using [Read the docs](https://readthedocs.org/) to host the documentation and the rendered version
can be found [here](https://ocelot.readthedocs.io).
Doc pages are authored in ReStructuredText (RST) - you can find a primer [here](http://www.sphinx-doc.org/en/stable/rest.html).
You can find more information about RTD and Sphinx under the following links:
* [Read the Docs documentation](https://docs.readthedocs.io/en/latest/index.html)
* [Sphinx](http://www.sphinx-doc.org/)
* [Getting started Screencast](https://www.youtube.com/watch?feature=player_embedded&v=oJsUvBQyHBs)