start docs

abhishekkrthakur · Nov 7, 2021 · 0753cc0 · 0753cc0
1 parent 1d8b3b3
commit 0753cc0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,7 +43,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,18 +3,11 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to mlspace's documentation!
+Welcome to MLSpace!
 ===================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   installation
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,12 @@
+Installation
+===================================
+
+There are multiple ways to install MLSpace. Easiest is if you have `python` and `pip` installed.
+
+If you already have `python` & `pip` installed on your system, you can just do:
+
+
+.. code-block:: bash
+
+    $ pip install -U mlspace
+