The new structure of documentation

Author: Fargk

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = embARC_MLI_Library
+SOURCEDIR     = documents
+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)

doc/documents/_static/style_overrides.css

@@ -0,0 +1,45 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+	.wy-table-responsive table td,
+	.wy-table-responsive table th {
+		/* !important prevents the common CSS stylesheets from overriding
+		 * this as on RTD they are loaded after this stylesheet */
+		white-space: normal !important;
+	}
+
+	.wy-table-responsive {
+		overflow: visible !important;
+	}
+}
+
+@media screen {
+	.wy-side-nav-search {
+		background-color: #5a2a82;
+	}
+
+	.wy-side-nav-search>div.version {
+		color: #b1b3b3;
+	}
+
+	.wy-nav-side {
+		background-color: #2e3b4e;
+	}
+
+	.wy-nav-content {
+		background-color: #f7f7fa;
+	}
+
+	body {
+		background-color: #f0f0f4;
+	}
+
+	.wy-side-nav-search::before {
+		content: "";
+		background-image: url("synopsys_wht.png");
+		width: 230px;
+		height: 50px;
+		display: block;
+		margin: 30px 0 30px 25px;
+	}
+}

doc/documents/_static/synopsys_wht.png

@@ -0,0 +1,215 @@
+# -*- coding: utf-8 -*-
+#
+# ML_RST documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 15 10:54:05 2019.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'embARC Machine Learning Inference Library'
+copyright = u'2019, Synopsys, Inc'
+author = u'Synopsys, Inc'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.00a'
+# The full version, including alpha/beta/rc tags.
+release = u'1.00a'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+#If true, figures and tables are numbered
+numfig = True
+
+# -- 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'
+
+# 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
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+html_context = {
+    'css_files': [
+        '_static/style_overrides.css',
+        ],
+}
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+#html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'embARC_MLI_Library'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+	# Increase limitations on the number of floats.
+	'preamble': '\usepackage{morefloats}',
+	'preamble': '\usepackage{float}',
+
+    # Latex figure (float) alignment
+	'figure_align': 'H',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'embARC_MLI_Library.tex', u'embARC Machine Learning Inference Library',
+     u'Synopsys', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'embARC_MLI_Library', u'embARC Machine Learning Inference Library',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'embARC_MLI_Library', u'embARC Machine Learning Inference Library',
+     author, 'embARC_MLI_Library', u'embARC Machine Learning Inference Library',
+     'Miscellaneous'),
+]
+
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+#epub_title = project
+#epub_author = author
+#epub_publisher = author
+#epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = ['search.html']
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'https://docs.python.org/': None}

doc/documents/conf.py

@@ -0,0 +1,26 @@
+.. _refs:
+
+References
+==========
+
+   [1] Q Notation: https://en.wikipedia.org/wiki/Q_(number_format)
+ 
+   [2] Q Notation tips and tricks: http://x86asm.net/articles/fixed-point-arithmetic-and-tricks/
+  
+   [3] TensorFlow–Neural Network details: https://www.tensorflow.org/api_guides/python/nn
+
+   [4] MetaWare DSP Programming Guide for ARC EM and ARC HS
+
+   [5] MetaWare Fixed-Point Reference for ARC EM and ARC HS
+
+   [6] Learning Multiple Layers of Features from Tiny Images, Alex Krizhevsky, 2009.
+ 
+   [7] Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor. Caffe\: Convolutional Architecture for Fast Feature Embedding. arXiv preprint  arXiv\:1408.5093, 2014. See http://caffe.berkeleyvision.org/
+   
+   [8] Guillaume Chevalier, LSTMs for Human Activity Recognition, 2016: https://github.com/guillaume-chevalier/LSTM-Human-Activity-Recognition
+   
+   [9] Davide Anguita, Alessandro Ghio, Luca Oneto, Xavier Parra and Jorge L. Reyes-Ortiz. A Public Domain Dataset for Human Activity Recognition Using Smartphones. 21th European Symposium on Artificial Neural Networks, Computational Intelligence and Machine Learning, ESANN 2013. Bruges, Belgium 24-26 April 2013. See https://www.elen.ucl.ac.be/Proceedings/esann/esannpdf/es2013-84.pdf
+
+..
+
+