An open API service indexing awesome lists of open source software.

https://github.com/dyweb/course

Dongyue Web Studio course and lecture
https://github.com/dyweb/course

course git

Last synced: 3 months ago
JSON representation

Dongyue Web Studio course and lecture

Awesome Lists containing this project

README

          

# README
Dongyue Web Studio course and lecture

- [View Documentation](https://course.readthedocs.io/en/latest/)
- [View Course website](https://dyweb.github.io/course/)

## How to write doc

- have `python` and `pip` installed. [python](https://www.python.org/)
- `pip install sphinx sphinx-autobuild` to install sphinx
- `pip install recommonmark` to install markdown support
- use `md` or `rst` file
- run `make html` to build html

## Syntax quick guide

- [Markdown Guide from GitHub](https://guides.github.com/features/mastering-markdown/)
- [Sphinx tutorial](http://www.sphinx-doc.org/en/stable/tutorial.html)
- [Sphinx common markups](http://www.sphinx-doc.org/en/stable/rest.html)
- [Sphinx example Readthedocs repo](https://github.com/rtfd/readthedocs.org)