DOC Added basic docs

docs/.gitignore

@@ -0,0 +1,4 @@
+doctrees
+html
+source/doxyoutput*
+source/library_api*

docs/requirements.txt

@@ -0,0 +1,8 @@
+
+# Required by the python script for building documentation. You probably won't have to install this (because you can
+# pre-commit hook builds docs for you and manages the environment).
+Sphinx==1.8.3
+sphinx-rtd-theme==0.4.2
+sphinx-tabs==1.1.10
+breathe==4.11.1
+exhale==0.2.1

docs/source/conf.py

@@ -0,0 +1,281 @@
+# -*- coding: utf-8 -*-
+#
+# Documentation build configuration file
+#
+# 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.
+
+import os
+import sphinx_rtd_theme
+
+# 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.
+# 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.
+# Breate and exhale are added as recommended by:
+#   https://exhale.readthedocs.io/en/latest/usage.html#usage-quickstart-guide
+extensions = [
+    'sphinx.ext.todo',
+    'sphinx_tabs.tabs',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'breathe',
+    'exhale'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'cpplot'
+copyright = u'Copyright 2017-20 Tom Clark'
+
+# 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 full version, including alpha/beta/rc tags.
+release = os.getenv('RELEASE_TAG', 'x.y.unknown')
+
+# The short X.Y version.
+version = '.'.join(release.split('.')[0:2])
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# -- Breathe and Exhale Configuration ------------------------------------------
+
+# Setup the breathe extension
+breathe_projects = {
+    "My Project": "./doxyoutput/xml"
+}
+breathe_default_project = "My Project"
+
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./library_api",
+    "rootFileName":          "library_root.rst",
+    "rootFileTitle":         "Library API",
+    "doxygenStripFromPath":  "../../",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    # TIP: if using the sphinx-bootstrap-theme, you need
+    # "treeViewIsBootstrap": True,
+    "exhaleExecutesDoxygen": True,
+    "exhaleDoxygenStdin":    "INPUT = ../../source"
+}
+
+# Tell sphinx what the primary language being documented is
+primary_domain = 'python'
+
+# Tell sphinx what the pygments highlight language should be
+highlight_language = 'python'
+
+
+# -- 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 themes here, relative to this directory.
+# html_theme_path = ["_themes",]
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = "cpplot: JSON based figures for C++"
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = 'favicon.ico'
+
+# 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']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+html_domain_indices = True
+
+# If false, no index is generated.
+html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'libraryDoc'
+
+# -- 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.
+    # 'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'cpplot.tex', u'cpplot',
+   u'T. Clark', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'cpplot', u'cpplot',
+     [u'T. Clark'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- 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 = [
+  ('index', 'cpplot', u'cpplot',
+   u'T. Clark', 'cpplot', 'JSON based figures for C++',
+   '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'

docs/source/example_chapter.rst

@@ -0,0 +1,60 @@
+.. _a_chapter:
+
+=========
+A Chapter
+=========
+
+Here is a paragraph
+
+Here are:
+    - several
+    - bullet
+    - points
+
+.. figure:: images/digital_twin_component_basic.svg
+    :width: 400px
+    :align: center
+    :figclass: align-center
+    :alt: Text description of the image
+
+    This is the caption of an svg file
+
+
+.. _a_section:
+
+A Section
+=========
+
+A link in rst is like
+`this <https://www.octue.com>`_.
+
+You cna create numbered bullets too. Here are some things that were important in the library which I made this template from:
+
+#. Openness
+#. Federation
+#. Security
+#. Public Good (cross ref other parts of the docs like this... :ref:`using_group_tabs`)
+
+
+.. _using_group_tabs:
+
+[Simple] Using Group Tabs
+=========================
+
+.. tabs::
+
+   .. group-tab:: Scenario
+
+      Some text appears in a tabbed box
+
+   .. group-tab:: Twine
+
+      A box can have ``code_values``.
+
+      And multiple paragraphs
+
+      .. code-block:: javascript
+
+         {
+             "and": "A Code Block",
+         }

docs/source/index.rst

@@ -0,0 +1,42 @@
+
+.. ATTENTION::
+    This library is in use in several projects, but it's still early days.
+    Like the idea of it? Please
+    `star us on GitHub <https://github.com/thclark/cpplot>`_ and contribute via the
+    `issues board <https://github.com/thclark/cpplot/issues>`_ and
+    `roadmap <https://github.com/thclark/cpplot/projects/1>`_.
+
+
+=============
+Library Title
+=============
+
+**{{library_name}}** is a library to do stuff.
+
+.. epigraph::
+   *"cpplot" ~ figures from C++, viewable in browser*
+
+Introduce the library here.
+
+Some parts of ReStructuredText (rst) are shown to help you write your docs in :ref:`a_chapter`.
+
+
+
+.. _reason_for_being:
+
+Raison d'etre
+=============
+
+Insert your personal rant here...
+
+
+
+.. toctree::
+   :maxdepth: 2
+
+   self
+   installation
+   quick_start
+   example_chapter
+   license
+   version_history