Migrate documentation to ReadTheDocs format

https://www.mkdocs.org is used as it provides ReadTheDocs support and requires only markdown files.
bees-hive · Jul 9, 2019 · 4eeaa4a · 4eeaa4a
1 parent 014755e
commit 4eeaa4a
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -47,3 +47,7 @@ Also, there are several optional addons which can be useful in some circumstance
 ## Test name template
 Use the following test name template - `'<command args>': <describe what will be tested>` like
 `'acquire-repository': raise an error if cloneable URL isn't set`.
+
+# Documentation preview
+Please install required dependencies by `pip install -r docs/requirements.txt`. After, run `mkdocs serve`
+and open <http://127.0.0.1:8000/> in a browser. That's it!
diff --git a/docs/README.md → docs/index.md b/docs/README.md → docs/index.md
diff --git a/docs/licence.md b/docs/licence.md
@@ -0,0 +1 @@
+../LICENSE
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+mkdocs==1.0.4
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,13 @@
+site_name: Elegant git
+site_url:
+site_description:
+site_author: Dmytro Serdiuk
+repo_url: https://github.com/bees-hive/elegant-git
+theme: readthedocs
+nav:
+  - Home: index.md
+  - License: licence.md
+
+copyright: Copyright &copy; 2019 <a href="https://extsoft.pro">Dmytro Serdiuk</a>, Maintained by <a href="https://github.com/bees-hive/elegant-git/graphs/contributors">project contributors</a>.
+plugins:
+    - search