o More docs for the ee project.

10 files changed, 81 insertions, 25 deletions

diff --git a/demo/doit/docs/report/index.rst b/demo/doit/docs/report/index.rst
index 98b460a..e49d09e 100644
--- a/demo/doit/docs/report/index.rst
+++ b/demo/doit/docs/report/index.rst
@@ -1,4 +1,4 @@
 Reports
--------
+=======
 
-* :doc:`messages`
+* :doc:`messages`
\ No newline at end of file
diff --git a/demo/doit/docs/report/messages.rst b/demo/doit/docs/report/messages.rst
index d2c6bd2..25bc464 100644
--- a/demo/doit/docs/report/messages.rst
+++ b/demo/doit/docs/report/messages.rst
@@ -1,5 +1,5 @@
 Messages
---------
+========
 
 There are 0 messages.
 
diff --git a/demo/doit/dodo.py b/demo/doit/dodo.py
index 74b621b..a9dca5c 100644
--- a/demo/doit/dodo.py
+++ b/demo/doit/dodo.py
@@ -29,9 +29,7 @@ def configure_report():
     doit_config.configure(data_set_manager=dsm, report_collection=report_collection, extra_config=extra_config)
 
 
-# Configure DoIt
 configure_logging()
-
 DOIT_CONFIG = {'check_file_uptodate': 'timestamp'}
 
 prj = "demo"
diff --git a/docs/Makefile b/docs/Makefile
index aa8ba09..c4c66da 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -2,11 +2,14 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = EETools
-SOURCEDIR     = .
-BUILDDIR      = _build
+SPHINXOPTS      =
+SPHINXBUILD     = sphinx-build
+SPHINXAUTOBUILD = sphinx-autobuild
+SPHINXPROJ      = EETools
+SOURCEDIR       = .
+BUILDDIR        = _build
+
+PATH:=$(shell pwd)/env/bin:$(PATH)
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -18,3 +21,13 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	rm -rf "$(BUILDDIR)"
+
+autobuild:
+	"$(SPHINXAUTOBUILD)" "$(SOURCEDIR)" "$(BUILDDIR)" \
+	    --ignore '*___jb_old___' \
+	    --ignore '*___jb_tmp___'
+
+.PHONY: clean
diff --git a/docs/background.rst b/docs/background.rst
new file mode 100644
index 0000000..80cbc48
--- /dev/null
+++ b/docs/background.rst
@@ -0,0 +1,7 @@
+Background
+==========
+
+.. warning::
+    This is just a bunch of notes that will be expanded on later.
+
+Automation is awesome. Electronics projects lack it.
diff --git a/docs/conf.py b/docs/conf.py
index eb831a7..c486425 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -63,7 +63,14 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'env',
+                    '**/*.rst___jb_old___',
+                    '**/*.rst___jb_tmp___',
+                    ]
+
+exclude_patterns += [
+    # "getting-started-dodo.rst",
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -74,7 +81,7 @@ pygments_style = 'sphinx'
 # 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'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/docs/getting-started-dodo.rst b/docs/getting-started-dodo.rst
new file mode 100644
index 0000000..649043f
--- /dev/null
+++ b/docs/getting-started-dodo.rst
@@ -0,0 +1,6 @@
+:orphan:
+
+Example dodo.py
+---------------
+
+.. literalinclude:: ../demo/doit/dodo.py
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
new file mode 100644
index 0000000..aeb023d
--- /dev/null
+++ b/docs/getting-started.rst
@@ -0,0 +1,17 @@
+Getting started
+===============
+
+In the directory where you have your KiCAD project, run::
+
+    virtualenv -p python3 env
+    echo env >> .gitignore
+
+    cat <<EOF > requirements.txt
+    -e git+https://trygvis.io/git/2017/07/ee-python.git#egg=ee
+    EOF
+    env/bin/pip install -r requirements
+
+Then we need to configure DoIt. DoIt is somewhat like make, with tasks (code to run), file dependencies (input files)
+and targets (output files). The exact
+
+See :doc:`getting-started-dodo`
diff --git a/docs/index.rst b/docs/index.rst
index 7c8a81e..212eb9d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,21 +1,28 @@
-.. EE Tools documentation master file, created by
-   sphinx-quickstart on Mon Jul 30 21:29:33 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+EE Tools
+========
+
+The ``ee`` project's main goals is to make it to automate and increase the quality of electronics engineering projects.
+
+The implementation 1) a bunch of Python code to work with EE-related programs and file formats and 2) a bunch of
+`DoIt <http://pydoit.org>`_ tasks.
+
+Currently the project support these tools:
+
+* `KiCAD <http://kicad.org>`_
+* `LTSpice <http://www.analog.com/en/design-center/design-tools-and-calculators/ltspice-simulator.html>`_
 
-Welcome to EE Tools's documentation!
-====================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-Hello world!
-
+   getting-started
+   background
 
-Indices and tables
-==================
+..
+   Indices and tables
+   ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 8d957d7..04c8577 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx
 sphinx-autobuild
+sphinx_rtd_theme