diff --git a/.gitignore b/.gitignore index 77146859b6e12b32e90cc6f6d388ebc878d548d6..4f40f8c4d9b2bf4eb9d898bbc0691a20c5663dd0 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 0000000000000000000000000000000000000000..49ba7c52dd4a9e284905fb8d383384252b77c3a9 --- /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 f55a39193eabc688fca65dc34bb6332c01be6a3b..39fb7fce5eabd328170ca8019c25c79c856fe8ab 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 871f41fbe83b44214aebc395eda59acd30bc5d5b..fdbcc7b16730d30986641a638a221e8241cb5cf0 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