Simplified doc-site generation
[AGL/documentation.git] / README.md
1 # agl-docs (master)
2 Revamping and restructuring Automotive Grade Linux's documentation site under GSoD'20.
3
4 -> [The working documentation site.](https://agl-docs.readthedocs.io)
5
6 -> [ReadTheDocs project page.](https://readthedocs.org/projects/agl-docs/)
7
8 ## To setup local build environment :
9
10 1) Clone this Repository : ```git clone https://github.com/growupboron/agl-docs.git```
11
12 2) Change into the directory : ```cd agl-docs/```
13
14 3) Install MkDocs and rtd-dropdown theme : ```sudo pip3 install -r requirements.txt```
15
16 4) Serve it, it would get defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/) : ```sudo mkdocs serve```
17
18