# Documentation

This section explains how to update and build the documentation.
All docs source files are located in the repo docs folder.

# CI-CD

The documentation is a static web site powered by vuepress.
It is automatically built and deployed each time a new commit is pushed to master.

# Notebooks

Beyond the markdown files located in the content folder, the notebooks that build the code snippets and embedded live grids are in the notebooks folder.

Some of these notebooks are available via a mybinder link.

Here is an overview of their roles:

• demo-build-dataframe-output-html.ipynb

  • Create regular sample dataframes HTML
  • Shown in the User Guide/Create/Parameters/Multi Index section

• demo-build-multiindex-dataframe-html.ipynb

  • Create multi-index sample dataframes HTML
  • Shown in the User Guide/Create/Parameters/Multi Index section

• load-ipywidget-css.ipynb

  • Load ipywidgets CSS - to be used in custom Excel style
  • Not present in the docs

• doc-builder.ipynb:

  • Creates the documentation code snippets and live demo grids, in fact vue components encapsulating the demo grids in iframes
  • Collection of live examples available for regular use
  • Link from the User Guide/Create section in TIP at top of page

• demo-ipyaggrid-python-functions.ipynb

  • Collection of live examples focused on the manipulation of the grid from Python
  • Link from the User Guide/Live Demo/MyBinder section

• demo-ipyaggrid-export-data.ipynb

  • Collection of live examples focused on the exporting of data from JavaScript to Python
  • Link from the User Guide/Create/Parameters/Export to Python section

• demo-ipyaggrid-customize.ipynb

  • Collection of live examples focused on advanced customization of the ag-Grid options using their API and the various JS injections points made available in ipyaggrid
  • Link from the User Guide/Customize/Live Demo section