diff --git a/docs/api/source/index.rst b/docs/api/source/index.rst index 50e6005a..0fc41214 100644 --- a/docs/api/source/index.rst +++ b/docs/api/source/index.rst @@ -20,6 +20,5 @@ Welcome to Trame's documentation! :caption: Tools tools.www.rst - tools.docker.rst .. include:: ../../../README.rst diff --git a/docs/api/source/tools.www.rst b/docs/api/source/tools.www.rst index fa7f7ac7..c97ecd3f 100644 --- a/docs/api/source/tools.www.rst +++ b/docs/api/source/tools.www.rst @@ -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 \ No newline at end of file