diff options
| author |   growupboron <shankhoghosh123@gmail.com> | 2020-09-11 17:18:57 +0530 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-09-11 12:11:56 +0000 |
| commit | 4aad369c9728061c97b3de792286e743ee884b09 (patch) | |
| tree | 14bddddeab334e3fdbdcf29446a87aa11cf6cd97 /README.md | |
| parent | 619a7e48085be1538c3b01eb93dcb9dc95bf0436 (diff) | |
Simplified doc-site generationjellyfish_9.99.4jellyfish/9.99.49.99.4
Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs
Signed-off-by: growupboron <shankhoghosh123@gmail.com>
Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..803cfcb --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# agl-docs (master) +Revamping and restructuring Automotive Grade Linux's documentation site under GSoD'20. + +-> [The working documentation site.](https://agl-docs.readthedocs.io) + +-> [ReadTheDocs project page.](https://readthedocs.org/projects/agl-docs/) + +## To setup local build environment : + +1) Clone this Repository : ```git clone https://github.com/growupboron/agl-docs.git``` + +2) Change into the directory : ```cd agl-docs/``` + +3) Install MkDocs and rtd-dropdown theme : ```sudo pip3 install -r requirements.txt``` + +4) Serve it, it would get defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/) : ```sudo mkdocs serve``` + + |