From f5b39719976905f76aaa007be72634b917fa47ba Mon Sep 17 00:00:00 2001
From: Russell Keith-Magee <russell@keith-magee.com>
Date: Wed, 26 Jun 2019 17:28:02 +0800
Subject: [PATCH] Add docs contribution guide.

---
 .gitignore                                    |  1 +
 docs/how-to/contribute-docs.rst               | 36 +++++++++++++++++++
 ...irements_docs.txt => requirements_rtd.txt} |  0
 3 files changed, 37 insertions(+)
 rename docs/{requirements_docs.txt => requirements_rtd.txt} (100%)

diff --git a/.gitignore b/.gitignore
index 75196d169d..607b4e09ea 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,3 +21,4 @@ tests/tmp*
 
 .DS_Store
 .idea/
+.vscode
\ No newline at end of file
diff --git a/docs/how-to/contribute-docs.rst b/docs/how-to/contribute-docs.rst
index e69de29bb2..818ccabe22 100644
--- a/docs/how-to/contribute-docs.rst
+++ b/docs/how-to/contribute-docs.rst
@@ -0,0 +1,36 @@
+Contributing to VOC's documentation
+===================================
+
+Here are some tips for working on this documentation. You're welcome to add
+more and help us out!
+
+First of all, you should check the `Restructured Text (reST) and Sphinx
+CheatSheet <http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_ to
+learn how to write your .rst file.
+
+To create a .rst file
+---------------------
+
+Look at the structure and choose the best category to put your .rst file. Make
+sure that it is referenced in the index of the corresponding category, so it
+will show on in the documentation. If you have no idea how to do this, study
+the other index files for clues.
+
+
+To build locally on GNU/Linux and open it on the browser:
+---------------------------------------------------------
+
+Go to the documentation folder: ::
+
+    $ cd docs
+
+Install Sphinx with the helpers and extensions we use: ::
+
+    $ pip install -r requirements_rtd.txt
+
+Create the static files: ::
+
+    $ make html
+
+Check for any errors and,if possible, fix them. The output of the file should
+be in the ``_build/html`` folder. Open the file you changed in the browser.
diff --git a/docs/requirements_docs.txt b/docs/requirements_rtd.txt
similarity index 100%
rename from docs/requirements_docs.txt
rename to docs/requirements_rtd.txt