Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c32454a
Update README
Nov 13, 2017
95aceff
Add that sphinx needs to be installed
Nov 13, 2017
3808751
Merge branch 'master' into update-README
martinvelez Mar 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Currently Hosted At
# Kodethon Documentation

This repository holds the source code for Kodethon documentation.

https://docs.kodethon.com

## Dependencies
Expand Down Expand Up @@ -38,11 +41,12 @@ sudo pip install sphinxcontrib-httpdomain
sudo pip install sphinx_rtd_theme
```

# How to Build the Docs
Run 'make html' in the respository root; files will be generated in the 'build' folder.
### How to Build the Docs
1. Install dependencies.
2. Run `make html` in the respository root; files will be generated in the `build/` folder.


# Structure
### Structure

CDE

Expand All @@ -64,5 +68,3 @@ LMS
* Create a course
* Create an assignment