From b7a8b9dd33101097aff330d17e5a216b194d6b51 Mon Sep 17 00:00:00 2001
From: Peter van 't Hof <p.j.van_t_hof@lumc.nl>
Date: Mon, 21 Sep 2015 19:34:31 +0200
Subject: [PATCH] Start on dev docs
---
.gitignore | 1 +
docs/developer/code-style.md | 4 ++++
docs/{ => general}/about.md | 0
docs/{ => general}/license.md | 0
docs/index.md | 4 ++--
mkdocs.yml | 6 ++++--
6 files changed, 11 insertions(+), 4 deletions(-)
create mode 100644 docs/developer/code-style.md
rename docs/{ => general}/about.md (100%)
rename docs/{ => general}/license.md (100%)
diff --git a/.gitignore b/.gitignore
index 77146859b..4f40f8c4d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,4 @@ git.properties
target/
public/target/
protected/target/
+site/
diff --git a/docs/developer/code-style.md b/docs/developer/code-style.md
new file mode 100644
index 000000000..49ba7c52d
--- /dev/null
+++ b/docs/developer/code-style.md
@@ -0,0 +1,4 @@
+# Developer - Code style
+
+- Variable names should alway be in *camelcase* and do **not** start with a capital letter
+- Class names should alway be in *Camelcase* and do **always** start with a capital letter
\ No newline at end of file
diff --git a/docs/about.md b/docs/general/about.md
similarity index 100%
rename from docs/about.md
rename to docs/general/about.md
diff --git a/docs/license.md b/docs/general/license.md
similarity index 100%
rename from docs/license.md
rename to docs/general/license.md
diff --git a/docs/index.md b/docs/index.md
index f55a39193..39fb7fce5 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -83,8 +83,8 @@ If everything builds fine, you're good to go! Otherwise, don't hesitate to conta
## About
-Go to the [about page](about.md)
+Go to the [about page](general/about.md)
## License
-See: [License](license.md)
+See: [License](general/license.md)
diff --git a/mkdocs.yml b/mkdocs.yml
index 871f41fbe..fdbcc7b16 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,6 +4,8 @@ pages:
- General:
- Config: 'general/config.md'
- Requirements: 'general/requirements.md'
+ - About: 'general/about.md'
+ - License: 'general/license.md'
- Pipelines:
- Basty: 'pipelines/basty.md'
- Bam2Wig: 'pipelines/bam2wig.md'
@@ -35,8 +37,8 @@ pages:
- 0.3.2: 'release_notes_0.3.2.md'
- 0.3.1: 'release_notes_0.3.1.md'
- 0.3.0: 'release_notes_0.3.0.md'
-- About: 'about.md'
-- License: 'license.md'
+- Developer:
+ - 'developer/code-style.md'
#- ['developing/Setup.md', 'Developing', 'Setting up your local development environment']
#theme: readthedocs
repo_url: https://github.com/biopet/biopet
--
GitLab