Skip to content

Commit

Permalink
DOCS-quantopian#22: Remove qgrid read-the-docs
Browse files Browse the repository at this point in the history
Signed-off-by: Richard Lin <[email protected]>
  • Loading branch information
richardlin047 committed Mar 25, 2021
1 parent b3c4089 commit df0c4cb
Show file tree
Hide file tree
Showing 6 changed files with 0 additions and 557 deletions.
11 changes: 0 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,17 +165,6 @@ Running automated tests
There is a small python test suite which can be run locally by running the command ``pytest`` in the root folder
of the repository.

Building docs
^^^^^^^^^^^^^
The read-the-docs page is generated using sphinx. If you change any doc strings or want to add something to the
read-the-docs page, you can preview your changes locally before submitting a PR using the following commands::

pip install sphinx sphinx_rtd_theme
cd docs && make html

This will result in the ``docs/_build/html`` folder being populated with a new version of the read-the-docs site. If
you open the ``index.html`` file in your browser, you should be able to preview your changes.

Events API
----------
As of qgrid 1.0.3 there are new ``on`` and ``off`` methods in qgrid which can be used to attach/detach event handlers. They're available on both the ``modin_spreadsheet`` module (see `qgrid.on <https://qgrid.readthedocs.io/en/latest/#qgrid.on>`_), and on individual SpreadsheetWidget instances (see `qgrid.QgridWidget.on <https://qgrid.readthedocs.io/en/latest/#qgrid.QgridWidget.on>`_). Previously the only way to listen for events was to use undocumented parts of the API.
Expand Down
192 changes: 0 additions & 192 deletions docs/Makefile

This file was deleted.

Loading

0 comments on commit df0c4cb

Please sign in to comment.