Merge pull request #3 from seeq12/docs

Docs

README.md

@@ -7,7 +7,7 @@ Digitization tools for Seeq
 
 ## User Guide
 
-Seeq Plot Digitizer is an addon tool designed to **streamline digitization of existing or legacy data**.
+Seeq Plot Digitizer is an addon tool designed to **streamline digitization of existing design documents in paper form**.
 <img src="imgs/digitize.png" style="width:100%;">
 
 The Plot Digitizer tool can also be used to **define a region of interest (ROI)**, resulting in creation of a new condition in Workbench.
@@ -30,10 +30,12 @@ file is published as a courtesy to the user, and it does not imply any obligatio
 
     c. Open the `external_calculation` (*i.e.*, `seeq-plot-digitizer/external_calculation`) folder from the repository you just downloaded.
 
-    d. **Move** (or copy and paste) the `PlotDigitizer` folder **and its contents** to the `python/user` external calculation folder on the machine where Seeq server is running, (this is typically `C:/Seeq/plugins/external-calculation/python/user/` or similar).
+    d. **Move** (or copy and paste) the `PltDgz` folder **and its contents** to the `python/user` external calculation folder on the machine where Seeq server is running, (this is typically `C:/Seeq/plugins/external-calculation/python/user/` or similar).
 
 	<img src="imgs/external_calc_upload.png" style="width:40%;">
 
+    **Very Important!** Once the `PltDgz` folder is created, be sure to never delete it. If you wish to make changes to the scripts contained therein, be sure to change the scripts themselves, never deleting, nor changing the name of the `PltDgz` folder!  
+
 
 2. Create a **new** Seeq Data Lab project and open the **Terminal** window
 

docs_src/Makefile

@@ -0,0 +1,24 @@
+# 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     = source
+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)
+
+github:
+	@make html
+	@cp -a build/html/. ../docs

docs_src/make.bat

@@ -0,0 +1,42 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+if "%1" == "github" (
+    %SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+    robocopy %BUILDDIR%/html ../docs /E > nul
+    echo.Generated files copied to ../docs
+    goto end
+)
+
+%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.https://www.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_src/requirements.txt

@@ -0,0 +1,43 @@
+alabaster==0.7.12
+attrs==21.4.0
+Babel==2.9.1
+certifi==2021.10.8
+charset-normalizer==2.0.12
+click==8.0.4
+colorama==0.4.4
+docutils==0.17.1
+ghp-import==2.0.2
+idna==3.3
+imagesize==1.3.0
+importlib-metadata==4.11.2
+Jinja2==3.0.3
+Markdown==3.3.6
+markdown-it-py==2.0.1
+MarkupSafe==2.1.0
+mdit-py-plugins==0.3.0
+mdurl==0.1.0
+mergedeep==1.3.4
+mkdocs==1.2.3
+myst-parser==0.17.0
+packaging==21.3
+Pygments==2.11.2
+pyparsing==3.0.7
+python-dateutil==2.8.2
+pytz==2021.3
+PyYAML==6.0
+pyyaml_env_tag==0.1
+requests==2.27.1
+six==1.16.0
+snowballstemmer==2.2.0
+Sphinx==4.4.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+typing_extensions==4.1.1
+urllib3==1.26.8
+watchdog==2.1.6
+zipp==3.7.0

docs_src/source/_static/css/custom.css

@@ -0,0 +1,54 @@
+
+
+.wy-grid-for-nav {
+    font-family: "Source Sans Pro", "Helvetica Neue", Helvetica, Arial, sans-serif;
+}
+
+html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt {
+    /*background: #e2d7eb;*/
+    background: #e3e3e3;
+    color: #7030A0;
+    border-top: 3px solid #9E7BB9;
+}
+
+.wy-menu-vertical header, .wy-menu-vertical p.caption {
+    color: #9E7BB9;
+}
+
+.wy-side-nav-search .wy-dropdown > a, .wy-side-nav-search > a {
+    color: #7030A0;
+    /*color: #ffffff;*/
+}
+
+.wy-side-nav-search > div.version {
+    color: #7030A0;
+    /*color: #ffffff;*/
+}
+
+.wy-nav-side {
+    background: #351852;
+    /*background: #d9d2e1;*/
+}
+
+/*.wy-menu-vertical li.toctree-l2.current > a, .wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a {*/
+/*    background: #c9c9c9;*/
+/*}*/
+
+/*.wy-menu-vertical a {*/
+/*    color: #222222;*/
+/*}*/
+
+/*.wy-menu-vertical a {*/
+/*    color: #cdcdcd;*/
+/*}*/
+
+/*!*.wy-alert-title {*!*/
+/*!*    color: #404040;*!*/
+/*!*    background: #e1e4e5*!*/
+/*!*}*!*/
+
+/*.wy-menu-vertical a:hover {*/
+/*    background-color: #bbbbbb;*/
+/*    cursor: pointer*/
+/*}*/
+

docs_src/source/conf.py

@@ -0,0 +1,114 @@
+# 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
+import re
+from parver import Version, ParseError
+
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'seeq-plot-digitizer'
+copyright = '2022, Eric Parsonnet'
+author = 'Eric Parsonnet'
+
+version_scope = {'__builtins__': None}
+with open("../../seeq/addons/plot_digitizer/_version.py", "r+") as f:
+    version_file = f.read()
+    version_line = re.search(r"__version__ = (.*)", version_file)
+    if version_line is None:
+        raise ValueError(f"Invalid version. Expected __version__ = 'xx.xx.xx', but got \n{version_file}")
+    version = version_line.group(1).replace(" ", "").strip('\n').strip("'").strip('"')
+    print(f"version: {version}")
+    try:
+        Version.parse(version)
+        exec(version_line.group(0), version_scope)
+    except ParseError as e:
+        print(str(e))
+        raise
+
+# The full version, including alpha/beta/rc tags
+version = version_scope['__version__']
+release = version_scope['__version__']
+
+# -- General configuration ---------------------------------------------------
+source_suffix = ['.rst', '.md']
+# 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.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.viewcode',
+    'myst_parser'
+]
+extensions.append('sphinx.ext.mathjax')
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
+# Enable numref
+numfig = True
+
+# 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 = []
+
+# -- 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 = 'sphinxdoc'
+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', '_usecases', '_userguide']
+
+html_favicon = '_static/seeq-favicon.ico'
+
+html_logo = '_static/Seeq_logo_darkPurple_sm.png'
+# html_logo = '_static/Seeq_logo_white_sm.png'
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    'css/custom.css',
+]
+
+# This will completely replace the theme stylesheet
+# html_style = 'css/yourtheme.css'
+
+html_theme_options = {
+    'style_external_links': True,
+    'style_nav_header_background': '#e3e3e3',
+}
+
+# Enable References
+myst_heading_anchors = 2
+
+# Enable Latex style Figure referencing
+myst_enable_extensions = ["colon_fence"]
+
+# Remove View page source
+html_show_sourcelink = False

docs_src/source/index.rst

@@ -0,0 +1,27 @@
+..
+    documentation master file, created by Ashwin Venkat
+
+
+Welcome to documentation for Plot Digitizer in Seeq
+==============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   Introduction <introduction.md>
+   Use Cases <use_cases.md>
+   User Guide <user_guide.md>
+   Release Notes <releasenotes.md>
+   Installation <installation.md>
+   License <license.md>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+

docs_src/source/installation.md

@@ -0,0 +1,30 @@
+(install)=
+# Installing Plot Digitizer
+
+The latest build of the project can be found [here](https://pypi.org/project/seeq-plot-digitizer/) as a wheel file. The
+file is published as a courtesy to the user, and it does not imply any obligation for support from the publisher.
+
+**Requires Seeq >= R56**
+
+
+1. Install the required external calculation scripts. 
+
+    a. Manually download the [Plot Digitizer repository](https://github.com/seeq12/seeq-plot-digitizer). To do so, click the green `Code` button, then Download ZIP
+
+	<img src="_static/zip_download.png" style="width:50%;">
+
+    b. **Unzip** repository after downloading
+
+    c. Open the `external_calculation` (*i.e.*, `seeq-plot-digitizer/external_calculation`) folder from the repository you just downloaded.
+
+    d. **Move** (or copy and paste) the `PltDgz` folder **and its contents** to the `python/user` external calculation folder on the machine where Seeq server is running, (this is typically `C:/Seeq/plugins/external-calculation/python/user/` or similar).
+
+	<img src="_static/external_calc_upload.png" style="width:40%;">
+
+    **Very Important!** Once the `PltDgz` folder is created, be sure to never delete it. If you wish to make changes to the scripts contained therein, be sure to change the scripts themselves, never deleting, nor changing the name of the `PltDgz` folder!  
+
+2. Create a **new** Seeq Data Lab project and open the **Terminal** window
+
+3. (In SDL Terminal) Run `pip install seeq-plot-digitizer`
+
+4. (In SDL Terminal) Run `python -m seeq.addons.plot_digitizer [--users <users_list> --groups <groups_list>]`. Then follow the prompt.