Skip to content

Commit

Permalink
docs(rtd): Update wwww
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed May 19, 2022
1 parent 1d7ad31 commit 13258ad
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 3 deletions.
1 change: 0 additions & 1 deletion docs/api/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,5 @@ Welcome to Trame's documentation!
:caption: Tools

tools.www.rst
tools.docker.rst

.. include:: ../../../README.rst
31 changes: 29 additions & 2 deletions docs/api/source/tools.www.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
WWW
===
wwww: Static Web Client generator
===================================================

This small utility let you run a command line to generate a static directory
that you can serve with Nginx/Apache for your trame application.

You just need to provide the `--output` directory if you don't want to add
to the current directory along with the list of module names that your application
is using or plan to use.

The following command line provide an example of what it could look like:

.. code-block:: bash
python -m trame.tools.www --output ./www-content www vuetify vtk plotly
Here is a list of known modules (so far)

* deckgl
* markdown
* matplotlib
* paraview
* plotly
* router
* trame
* vega
* vtk
* vuetify
* www <-- Main client code

0 comments on commit 13258ad

Please sign in to comment.