documentation

developer documentation
Log | Files | Refs | README | git clone https://git.ne02ptzero.me/git/documentation

commit 3b5d8ab073e915d3ac265ab5c57dd0f1974e749b
parent aaeda10dd1ff2eed65f98186250066eee2e03f15
Author: Ne02ptzero <louis@ne02ptzero.me>
Date:   Tue,  6 Dec 2016 15:56:21 +0100

Add(mkdocs): New documentation

Diffstat:
A.gitignore | 1+
MREADME.md | 15++++++++++++---
RInfrastructure.md -> docs/Infrastructure.md | 0
RPackage.md -> docs/Package.md | 0
CREADME.md -> docs/index.md | 0
Amkdocs.yml | 6++++++
6 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -0,0 +1 @@ +site/ diff --git a/README.md b/README.md @@ -1,4 +1,13 @@ -# Morphux Documentation +# Morphux documentation -- [Infrastructure](Infrastructure.md) -- [Package](Package.md) +## Build the documentation + +### Install mkdocs +``` +pip install mkdocs +``` + +### Build +``` +mkdocs build +``` diff --git a/Infrastructure.md b/docs/Infrastructure.md diff --git a/Package.md b/docs/Package.md diff --git a/README.md b/docs/index.md diff --git a/mkdocs.yml b/mkdocs.yml @@ -0,0 +1,6 @@ +site_name: Morphux Documentation +pages: + - Home: index.md + - Packages: Package.md + - Infrastructure: Infrastructure.md +theme: readthedocs