how to contribute

Saikat248 · Dec 18, 2021 · 7cd92e8 · 7cd92e8
1 parent 8ead818
commit 7cd92e8
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 1 deletion.
diff --git a/docs/how_to_contribute.rst b/docs/how_to_contribute.rst
@@ -0,0 +1,44 @@
+.. _how_to_contribute:
+
+How to Contribute
+=================
+
+This website is build with the help of `readthedocs.org <https://readthedocs.org/>`_ and `Sphinx <https://www.sphinx-doc.org/en/master/>`_
+with ``sphinx_rtd_theme``
+
+You can read their documentation for details.
+
+Installation
+------------
+
+Clone the github repo
+.. code:: console
+
+	$ git clone https://github.com/Saikat248/anooplab-docs.git
+
+and install this two packages 
+
+.. code:: console
+
+	$ pip install sphinx
+	$ pip install sphinx_rtd_theme
+
+
+Navigate to ``anooplab-docs/docs`` directory 
+
+there is a ``Makefile`` and start
+
+.. code:: console
+
+	$ make html 
+
+It will create a ``_build`` directory and the ``html`` files
+
+.. code:: console 
+
+	$ firefox _build/html/index.html
+
+The whole website will run locally.
+Go ahead start editing the documents and before pushing make sure if the build is successful.
+
+Enjoy !!
diff --git a/docs/index.rst b/docs/index.rst
@@ -78,6 +78,7 @@ External Libraries/Packages
 
    license
    credits
+   how_to_contribute
 
 ..
   * :ref:`genindex`

diff --git a/docs/python/condasetup.rst b/docs/python/condasetup.rst
@@ -75,7 +75,7 @@ and deactivate it by
 	conda deactivate
 
 
-You can also install different environment environment with required package.
+You can also install different environment with required package.
 Details documentation is `here <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`_.
 
 .. tip::