reorg

minima-global · Dec 30, 2020 · c44b0f7 · c44b0f7
1 parent 4feea97
commit c44b0f7
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ node_modules/
 
 # docs
 docs/_build
+docs/_static
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,19 @@
+# Minima Documentation
+
+This directory contains documentation for _minima.js_.
+
+The files use [reStructuredText](https://rest-sphinx-memo.readthedocs.io/en/latest/ReST.html), targeted at [sphinx](https://www.sphinx-doc.org/en/master/).
+
+If you do not have sphinx installed, then:
+
+```
+pip install sphinx
+```
+
+Once sphinx installed, generate the docs:
+
+```
+make html
+```
+
+That will create a static documentation website in _./build/html_.
diff --git a/docs/api/init.rst b/docs/api/init.rst
@@ -0,0 +1,7 @@
+####
+Init
+####
+
+.. _apiInit:
+
+`Minima.init` allows you to specify a callback that enables you to monitor Minima events.
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 project = 'minima.js'
 copyright = '2020, Minima Global'
 author = 'Steve Huckle'
-
+master_doc = 'index'
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/docs/initialise.rst → docs/gettingStarted/initialise.rst b/docs/initialise.rst → docs/gettingStarted/initialise.rst
@@ -2,11 +2,10 @@
 Initialising Minima
 ###################
 
+.. _gettingStartedInitialise:
 
-.. _initialise minima.js:
-
-Initialise Example
-==================
+Example
+=======
 
 ::
 

diff --git a/docs/install.rst → docs/gettingStarted/install.rst b/docs/install.rst → docs/gettingStarted/install.rst
@@ -2,7 +2,7 @@
 Install minima.js
 #################
 
-.. _install minima.js:
+.. _gettingStartedInstall:
 
 Install
 =======

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,12 +17,13 @@ Contents
 
 .. toctree::
    :maxdepth: 2
-   :caption: Basics:
+   :caption: Getting Started:
 
-   install.rst
+   gettingStarted/install.rst
+   gettingStarted/initialise.rst
 
 .. toctree::
    :maxdepth: 2
-   :caption: API Description:
+   :caption: API:
 
-   initialise.rst
+   api/init.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,3 +8,4 @@ node_modules/

		# docs
		docs/_build
		docs/_static