Added an automatically generated documentation website

Finesse · Dec 12, 2018 · 35a4c35 · 35a4c35
1 parent 56d14d2
commit 35a4c35
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ If you need a dialect support please extend the `CommonGrammar` class and make a
 
 ## Documentation
 
-The documentation is located in [the `docs` directory](docs/getting-started.md).
+The documentation is available at [queryscribe.readthedocs.io](http://queryscribe.readthedocs.io).
 
 Also all the classes, methods and properties has a PHPDoc comment in the code.
 

diff --git a/docs/building-queries.md b/docs/building-queries.md
@@ -1,10 +1,3 @@
-* [Getting started](getting-started.md)
-* **Building queries**
-* [Table prefixes](table-prefixes.md)
-* [Making SQL from query](making-sql.md)
-* [Helpers](helpers.md)
-
-
 # Building queries
 
 ## Select

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,10 +1,3 @@
-* **Getting started**
-* [Building queries](building-queries.md)
-* [Table prefixes](table-prefixes.md)
-* [Making SQL from query](making-sql.md)
-* [Helpers](helpers.md)
-
-
 # Getting started
 
 ## Installation

diff --git a/docs/helpers.md b/docs/helpers.md
@@ -1,10 +1,3 @@
-* [Getting started](getting-started.md)
-* [Building queries](building-queries.md)
-* [Table prefixes](table-prefixes.md)
-* [Making SQL from query](making-sql.md)
-* Helpers
-
-
 # Helpers
 
 ## Escape LIKE special wildcard characters

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,4 @@
+Welcome to the Query Scribe documentation.
+
+The available pages are listed in the menu.
+The source code is available by clicking the «GitHub» link.
diff --git a/docs/making-sql.md b/docs/making-sql.md
@@ -1,10 +1,3 @@
-* [Getting started](getting-started.md)
-* [Building queries](building-queries.md)
-* [Table prefixes](table-prefixes.md)
-* **Making SQL from query**
-* [Helpers](helpers.md)
-
-
 # Making SQL from query
 
 A `Query` object can be compiled to an SQL text with bindings using a grammar object.

diff --git a/docs/table-prefixes.md b/docs/table-prefixes.md
@@ -1,10 +1,3 @@
-* [Getting started](getting-started.md)
-* [Building queries](building-queries.md)
-* **Table prefixes**
-* [Making SQL from query](making-sql.md)
-* [Helpers](helpers.md)
-
-
 # Table prefixes
 
 Use the `TablePrefixer` class to add prefixes to all the tables in a query:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,10 @@
+site_name: Query Scribe
+repo_url: http://github.com/Finesse/QueryScribe
+theme: readthedocs
+pages:
+    - Home: index.md
+    - Getting started: getting-started.md
+    - Building queries: building-queries.md
+    - Table prefixes: table-prefixes.md
+    - Making SQL from query: making-sql.md
+    - Helpers: helpers.md