Restructure file hierarchy

coala · Aug 18, 2016 · d4763fa · d4763fa
1 parent a0f45bd
commit d4763fa
Show file tree

Hide file tree

Showing 21 changed files with 22 additions and 28 deletions.
diff --git a/Getting_Involved/Codestyle.rst → Developers/Codestyle.rst b/Getting_Involved/Codestyle.rst → Developers/Codestyle.rst
diff --git a/Users/Tutorials/Development_Setup.rst → Developers/Development_Setup.rst b/Users/Tutorials/Development_Setup.rst → Developers/Development_Setup.rst
diff --git a/Getting_Involved/Testing.rst → Developers/Executing_Tests.rst b/Getting_Involved/Testing.rst → Developers/Executing_Tests.rst
diff --git a/Getting_Involved/README.rst → Developers/Getting_In_Touch.rst b/Getting_Involved/README.rst → Developers/Getting_In_Touch.rst
diff --git a/Users/Tutorials/Git_Help.rst → Developers/Git_Basics.rst b/Users/Tutorials/Git_Help.rst → Developers/Git_Basics.rst
diff --git a/Getting_Involved/Newcomers.rst → Developers/Newcomers_Guide.rst b/Getting_Involved/Newcomers.rst → Developers/Newcomers_Guide.rst
diff --git a/Getting_Involved/Review.rst → Developers/Review.rst b/Getting_Involved/Review.rst → Developers/Review.rst
diff --git a/Users/Tutorials/Self_Correcting_Bears.rst → Developers/Self_Correcting_Bears.rst b/Users/Tutorials/Self_Correcting_Bears.rst → Developers/Self_Correcting_Bears.rst
diff --git a/Users/Tutorials/Testing_Bears.rst → Developers/Testing_Bears.rst b/Users/Tutorials/Testing_Bears.rst → Developers/Testing_Bears.rst
diff --git a/Users/Tutorials/Writing_Bears.rst → Developers/Writing_Bears.rst b/Users/Tutorials/Writing_Bears.rst → Developers/Writing_Bears.rst
diff --git a/Getting_Involved/Writing_Documentation.rst → Developers/Writing_Documentation.rst b/Getting_Involved/Writing_Documentation.rst → Developers/Writing_Documentation.rst
diff --git a/Getting_Involved/Writing_Good_Commits.rst → Developers/Writing_Good_Commits.rst b/Getting_Involved/Writing_Good_Commits.rst → Developers/Writing_Good_Commits.rst
diff --git a/Users/Tutorials/Linter_Bears.rst → Developers/Writing_Linter_Bears.rst b/Users/Tutorials/Linter_Bears.rst → Developers/Writing_Linter_Bears.rst
diff --git a/Getting_Involved/Writing_Tests.rst → Developers/Writing_Tests.rst b/Getting_Involved/Writing_Tests.rst → Developers/Writing_Tests.rst
diff --git a/Users/FAQ.rst → Help/FAQ.rst b/Users/FAQ.rst → Help/FAQ.rst
diff --git a/Getting_Involved/MAC_Hints.rst → Help/MAC_Hints.rst b/Getting_Involved/MAC_Hints.rst → Help/MAC_Hints.rst
diff --git a/Users/Container.rst → Users/Docker_Image.rst b/Users/Container.rst → Users/Docker_Image.rst
diff --git a/Users/Tutorials/Shell_Autocompletion.rst → Users/Shell_Autocompletion.rst b/Users/Tutorials/Shell_Autocompletion.rst → Users/Shell_Autocompletion.rst
diff --git a/Users/Tutorials/Tutorial.rst → Users/Tutorial.rst b/Users/Tutorials/Tutorial.rst → Users/Tutorial.rst
diff --git a/Users/Git_Hooks.rst → Users/coala_as_Git_Hook.rst b/Users/Git_Hooks.rst → Users/coala_as_Git_Hook.rst
diff --git a/index.rst b/index.rst
@@ -25,46 +25,40 @@ Welcome to the coala documentation!
    :hidden:
 
    Installing coala <Users/Install>
-   Getting Started with coala <Users/Tutorials/Tutorial>
+   Getting Started with coala <Users/Tutorial>
    Writing a coala Configuration File (coafile) <Users/coafile>
    Using Glob Patterns <Users/Glob_Patterns>
    Exit Codes <Users/Exit_Codes>
    External APIs <Users/External_APIs>
-   Adding coala as a Git Hook <Users/Git_Hooks>
-   Shell Autocompletion <Users/Tutorials/Shell_Autocompletion>
-   coala as a Docker Image <Users/Container>
+   Adding coala as a Git Hook <Users/coala_as_Git_Hook>
+   Shell Autocompletion <Users/Shell_Autocompletion>
+   coala as a Docker Image <Users/Docker_Image>
 
 .. toctree::
    :caption: For Developers
    :hidden:
 
-   Newcomers' Guide <Getting_Involved/Newcomers>
-   Writing Good Commit Messages <Getting_Involved/Writing_Good_Commits>
-   Codestyle <Getting_Involved/Codestyle>
-   Git Basics <Users/Tutorials/Git_Help>
-   Review <Getting_Involved/Review>
-   How To Get In Touch With Us <Getting_Involved/README>
-   Development Setup <Users/Tutorials/Development_Setup>
-   Writing Bears <Users/Tutorials/Writing_Bears>
-   Writing Linter Bears <Users/Tutorials/Linter_Bears>
-   Linter Bears - Suggesting Corrections <Users/Tutorials/Self_Correcting_Bears>
-   Testing Bears <Users/Tutorials/Testing_Bears>
-   Writing Tests <Getting_Involved/Writing_Tests>
-   Writing Documentation <Getting_Involved/Writing_Documentation>
-   Executing Tests <Getting_Involved/Testing>
+   Newcomers' Guide <Developers/Newcomers_Guide>
+   Writing Good Commit Messages <Developers/Writing_Good_Commits>
+   Codestyle <Developers/Codestyle>
+   Git Basics <Developers/Git_Basics>
+   Review <Developers/Review>
+   How To Get In Touch With Us <Developers/Getting_In_Touch>
+   Development Setup <Developers/Development_Setup>
+   Writing Bears <Developers/Writing_Bears>
+   Writing Linter Bears <Developers/Writing_Linter_Bears>
+   Linter Bears - Suggesting Corrections <Developers/Self_Correcting_Bears>
+   Testing Bears <Developers/Testing_Bears>
+   Writing Tests <Developers/Writing_Tests>
+   Writing Documentation <Developers/Writing_Documentation>
+   Executing Tests <Developers/Executing_Tests>
 
 .. toctree::
    :caption: Help
    :hidden:
 
-   Frequently Asked Questions <Users/FAQ>
-   MAC Hints <Getting_Involved/MAC_Hints>
-
-.. toctree::
-   :caption: API Documentation
-   :hidden:
-
-   List of Modules (Generated)<API/modules>
+   Frequently Asked Questions <Help/FAQ>
+   MAC Hints <Help/MAC_Hints>
 
 You might also want to look at `our website <https://coala-analyzer.org/>`_.
 
@@ -108,7 +102,7 @@ To see what coala can do for you and your language, take a look at
 
 To get started, take a look at our :doc:`Installation
 Instructions <Users/Install>` and the
-:doc:`Tutorial <Users/Tutorials/Tutorial>`.
+:doc:`Tutorial <Users/Tutorial>`.
 
 What do I get?
 --------------
@@ -133,7 +127,7 @@ coala automates the organization of settings, user interaction and
 execution parallelization. You shouldn't need to care about anything
 else than just writing your algorithm!
 
-See :doc:`Writing Bears <Users/Tutorials/Writing_Bears>` for more information on
+See :doc:`Writing Bears <Developers/Writing_Bears>` for more information on
 this.
 
 Also, coala provides an external API using the dbus message protocol.