initialize docs

README.md

@@ -23,11 +23,11 @@ The goal of EDAAC is to make it painless to perform the following tasks:
 
 ### Install
 ```
-> pip install edaac
+    $ pip install edaac
 ```
 
-### Tutorials
-To be updated ..
+### Documentation
+[https://edaac.readthedocs.io/en/latest/](https://edaac.readthedocs.io/en/latest/)
 
 
 ## License

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1,23 @@
+# EDAAC Documentation
+
+This documentation is available at [https://edaac.readthedocs.io/en/latest/](https://edaac.readthedocs.io/en/latest/)
+
+## Build locally
+
+### Requires:
+- Python 3.x
+- Pip
+- virtualenv
+
+### Install pre-requisites
+```
+virtualenv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Build
+
+```
+make html
+```

docs/conf.py

@@ -0,0 +1,59 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'EDA Analytics Central'
+copyright = 'EDA Analytics Central, 2020'
+author = 'Abdelrahman Hosny'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosectionlabel'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+source_suffix = ['.rst', '.md']
+
+autosectionlabel_prefix_document = True

docs/guide/collecting-metrics.rst

@@ -0,0 +1,5 @@
+===================
+Collecting Metrics
+===================
+
+To be updated.

docs/guide/data-storage.rst

@@ -0,0 +1,5 @@
+=============
+Data Storage
+=============
+
+To be updated

docs/guide/index.rst

@@ -0,0 +1,10 @@
+==========
+User Guide
+==========
+
+.. toctree::
+   :maxdepth: 2
+
+   installing
+   collecting-metrics
+   data-storage

docs/guide/installing.rst

@@ -0,0 +1,32 @@
+=================
+Installing EDAAC
+=================
+
+To use EDAAC, you will need to download `MongoDB <http://mongodb.com/>`_
+and ensure it is running in an accessible location. You will also need
+`MongoEngine <http://mongoengine.org/>`_ to use EDAAC, but if you
+install EDAAC using setuptools, then the dependencies will be handled for
+you.
+
+EDAAC is available on PyPI, so you can use :program:`pip`:
+
+.. code-block:: console
+
+    $ pip install edaac
+
+Alternatively, if you don't have setuptools installed, `download it from PyPi
+<https://pypi.org/project/edaac/>`_ and run
+
+.. code-block:: console
+
+    $ python setup.py install
+
+To use the bleeding-edge version of EDAAC, you can get the source from
+`GitHub <http://github.com/EDAAC/EDAAC/>`_ and install it as above:
+
+.. code-block:: console
+
+    $ git clone git://github.com/EDAAC/EDAAC
+    $ cd EDAAC
+    $ python setup.py install
+

docs/index.rst

@@ -0,0 +1,55 @@
+============================================
+EDA Analytics Central - User Documentation
+============================================
+
+**EDAAC** is a Python package to collect, store and analyze data coming out of EDA (*Electronic Design Automation*) Flows.
+
+.. code-block:: console
+
+    $ pip install -U edaac
+
+:doc:`tutorial`
+  A quick tutorial extracting *Design Rule Violations (DRVs)* from
+  Cadence Innovus log file to get you up and running with EDAAC.
+
+:doc:`guide/index`
+  The Full guide to EDAAC --- from collecting metrics to storing them,
+  from querying for data to advanced analytics and *everything* between.
+
+Community
+---------
+
+To get help with using EDAAC, use the `GitHub Issues
+<https://github.com/EDAAC/EDAAC/issues>`_ and label the issue with `question`.
+
+Contributing
+------------
+
+**Yes please!**  
+
+EDAAC is a young project and we are looking for contributions, additions and improvements.
+
+The source is available on `GitHub <http://github.com/EDAAC/EDAAC>`_
+and contributions are always encouraged. Contributions can be as simple as
+minor tweaks to this documentation, API names, or event the core architecture.
+
+To contribute, fork the project on
+`GitHub <http://github.com/EDAAC/EDAAC>`_ and send a
+pull request.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+   :numbered:
+   :hidden:
+
+   tutorial
+   guide/index
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,27 @@
+alabaster==0.7.12
+Babel==2.8.0
+certifi==2019.11.28
+chardet==3.0.4
+commonmark==0.9.1
+docutils==0.16
+idna==2.8
+imagesize==1.2.0
+Jinja2==2.11.1
+MarkupSafe==1.1.1
+packaging==20.1
+Pygments==2.5.2
+pyparsing==2.4.6
+pytz==2019.3
+recommonmark==0.6.0
+requests==2.22.0
+six==1.14.0
+snowballstemmer==2.0.0
+Sphinx==2.4.1
+sphinx-rtd-theme==0.4.3
+sphinxcontrib-applehelp==1.0.1
+sphinxcontrib-devhelp==1.0.1
+sphinxcontrib-htmlhelp==1.0.2
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.2
+sphinxcontrib-serializinghtml==1.1.3
+urllib3==1.25.8