docs(website): update content to match new api

.gitignore

@@ -121,4 +121,6 @@ dmypy.json
 .pytype/
 
 # Cython debug symbols
-cython_debug/
+cython_debug/
+
+node_modules

docs/.gitignore

@@ -0,0 +1 @@
+build-tmp

docs/api/README.md

@@ -0,0 +1,38 @@
+# API Documentation
+
+These are docs autogenerated from the module itself.
+
+# Building API Documentation
+
+You must build the docs with a python interpreter that has sphinx and trame dependencies. We recommend using a virtual environment and the requirements.txt dependencies provided in this directory.
+```
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r docs/api/requirements.txt
+sphinx-build docs/api/source/ docs/api/dist/
+```
+
+# Adding new module
+1. Copy this template into a new file in this directory, changeing `myCoolModule` to your module name.
+```
+trame.html.myCoolModule
+======================
+.. automodule:: trame.html.myCoolModule
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+2. (Optional) Hide parts of the module with `:exclude-members:`. You can see an example of this in `trame.html.vtk.rst`.
+
+3. (Optional) Show imported members with `:imported-members:`. You can see an example of this in `trame.html.vtk.rst`.
+
+4. Preview your docs by building and opening index.html
+
+# Expected warnings:
+
+We expose `vtk.common.*` through both html.paraview and html.vtk, which confuses the index for sphinx. We get many warnings looking like this.
+```
+WARNING: duplicate object description of trame.html.vtk.common.*, other instance in trame.html.paraview, use :noindex: for one of them
+```
+

docs/api/requirements.txt

@@ -0,0 +1,61 @@
+aiohttp==3.7.4.post0
+alabaster==0.7.12
+astunparse==1.6.3
+async-timeout==3.0.1
+attrs==21.2.0
+Babel==2.9.1
+certifi==2021.10.8
+chardet==4.0.0
+charset-normalizer==2.0.7
+click==8.0.3
+docutils==0.17.1
+ghp-import==2.0.2
+html2text==2020.1.16
+idna==3.3
+imagesize==1.2.0
+importlib-metadata==4.8.1
+Jinja2==3.0.2
+Markdown==3.3.4
+markdown-it-py==1.1.0
+MarkupSafe==2.0.1
+mdit-py-plugins==0.2.8
+mergedeep==1.3.4
+mkdocs==1.2.3
+mkdocs-autorefs==0.3.0
+mkdocstrings==0.16.2
+multidict==5.2.0
+myst-parser==0.15.2
+packaging==21.2
+pydash==5.1.0
+Pygments==2.10.0
+pymdown-extensions==9.0
+pyparsing==2.4.7
+python-dateutil==2.8.2
+pytkdocs==0.12.0
+pytz==2021.3
+pywebvue==2.1.10
+PyYAML==6.0
+pyyaml-env-tag==0.1
+requests==2.26.0
+simput==2.0.0
+six==1.16.0
+snowballstemmer==2.1.0
+Sphinx==4.2.0
+sphinx-markdown-builder==0.5.4
+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==3.10.0.2
+unify==0.5
+untokenize==0.1.1
+urllib3==1.26.7
+vtk>=9.0.1
+watchdog==2.1.6
+wslink==1.1.0
+yapf==0.31.0
+yarl==1.7.0
+zipp==3.6.0

docs/api/source/conf.py

@@ -0,0 +1,81 @@
+# 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
+
+this_dir = os.path.dirname(os.path.realpath(__file__))
+sys.path.insert(0, os.path.join(this_dir, "/../../../trame"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "trame"
+copyright = "2021, Kitware Inc."
+author = "Kitware Inc."
+
+
+# -- 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.
+import sphinx_rtd_theme
+
+extensions = [
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.todo",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# 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 = "en"
+
+# 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 = "alabaster"
+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"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+autodoc_mock_imports = ["vtkmodules.vtkWebCore", "vtkmodules.web", "pywebvue.modules"]
+
+autodoc_member_order = "bysource"

docs/api/source/index.rst

@@ -0,0 +1,19 @@
+.. trame documentation master file, created by
+   sphinx-quickstart on Wed Nov  3 09:45:49 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to trame's documentation!
+=================================
+
+This is the auto-generated API documentation for trame, but the project website is `here <https://kitware.github.io/trame/>`_ with additional guides.
+All classes are listed in the :ref:`genindex`.
+
+.. toctree::
+   :maxdepth: 1
+
+   trame
+   trame.html
+   trame.layouts
+
+.. include:: ../../../README.rst

docs/api/source/trame.html.deckgl.rst

@@ -0,0 +1,13 @@
+trame.html.deckgl
+=========================
+
+You can find more information about using deck.gl with trame |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-deckgl.html" target="_blank">here</a>
+
+.. automodule:: trame.html.deckgl
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/source/trame.html.markdown.rst

@@ -0,0 +1,12 @@
+trame.html.markdown
+===========================
+
+You can find more information about using Markdown with trame |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-markdown.html" target="_blank">here</a>
+.. automodule:: trame.html.markdown
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/source/trame.html.paraview.rst

@@ -0,0 +1,19 @@
+trame.html.paraview
+===========================
+
+These auto-generated docs only show this module's objects, which rely on keyword arguments (`**kwargs`) for configuration. You can find more information about using Paraview with trame |module_link|, or more about these components in the vue-vtk-js documentation |paraview_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-paraview.html" target="_blank">here</a>
+
+.. |paraview_link| raw:: html
+
+   <a href="https://github.com/Kitware/vue-vtk-js/tree/master/src/core" target="_blank">here</a>
+
+.. automodule:: trame.html.paraview
+   :members:
+   :undoc-members:
+   :imported-members:
+   :exclude-members: use_module, get_app_instance, AbstractElement
+   :show-inheritance:

docs/api/source/trame.html.rst

@@ -0,0 +1,27 @@
+trame.html
+==================
+
+This module provides the fundamental elements for HTML and the root class for the ``trame.html`` submodules. 
+
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   trame.html.deckgl
+   trame.html.markdown
+   trame.html.paraview
+   trame.html.simput
+   trame.html.vega
+   trame.html.vtk
+   trame.html.vuetify
+   trame.html.widgets
+
+__init__.py
+---------------
+
+.. automodule:: trame.html
+   :members:
+   :undoc-members:
+   :exclude-members: ElementContextManager, py2js_key, str_key_prefix
+   :show-inheritance:

docs/api/source/trame.html.simput.rst

@@ -0,0 +1,13 @@
+trame.html.simput
+=========================
+
+These auto-generated docs only show this module's objects, which rely on keyword arguments (`**kwargs`) for configuration. You can find more information in the modules section |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-simput.html" target="_blank">here</a>
+
+.. automodule:: trame.html.simput
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/source/trame.html.vega.rst

@@ -0,0 +1,13 @@
+trame.html.vega
+=======================
+
+You can find more information about using Vega with trame |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-vega.html" target="_blank">here</a>
+
+.. automodule:: trame.html.vega
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/source/trame.html.vtk.rst

@@ -0,0 +1,20 @@
+trame.html.vtk
+======================
+
+These auto-generated docs only show this module's objects, which rely on keyword arguments (`**kwargs`) for configuration. You can find more information in the trame modules section |module_link|, or more about these components in the vue-vtk-js documentation |vtk_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-vtk.html" target="_blank">here</a>
+
+.. |vtk_link| raw:: html
+
+   <a href="https://github.com/Kitware/vue-vtk-js/tree/master/src/core" target="_blank">here</a>
+
+.. automodule:: trame.html.vtk
+   :members:
+   :undoc-members:
+   :imported-members:
+   :exclude-members: use_module, get_app_instance, AbstractElement
+   :show-inheritance:
+

docs/api/source/trame.html.vuetify.rst

@@ -0,0 +1,15 @@
+trame.html.vuetify
+==========================
+
+
+You can find more information about using Vuetify with trame |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-vuetify.html" target="_blank">here</a>
+
+.. automodule:: trame.html.vuetify
+   :members:
+   :undoc-members:
+   :exclude-members: cast_to_serializable
+   :show-inheritance:

docs/api/source/trame.html.widgets.rst

@@ -0,0 +1,13 @@
+trame.html.widgets
+==========================
+
+These auto-generated docs only show this module's objects, which rely on keyword arguments (`**kwargs`) for configuration. You can find more information in the modules section |module_link|.
+
+.. |module_link| raw:: html
+
+   <a href="https://kitware.github.io/trame/docs/module-widgets.html" target="_blank">here</a>
+
+.. automodule:: trame.html.widgets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/source/trame.layouts.rst

@@ -0,0 +1,8 @@
+trame.layouts
+=====================
+
+.. automodule:: trame.layouts
+   :members:
+   :undoc-members:
+   :imported-members:
+   :show-inheritance:

docs/api/source/trame.rst

@@ -0,0 +1,12 @@
+trame
+=============
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+.. automodule:: trame
+  :members:
+  :undoc-members:
+  :exclude-members:
+  :show-inheritance: