Skip to content

Commit 956595f

Browse files
committed
DOCS-quantopian#22: Fix code formatting on figures
Signed-off-by: Richard Lin <[email protected]>
1 parent 14bc0d4 commit 956595f

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ about Qgrid, here is an `introduction on YouTube <https://www.youtube.com/watch?
2222

2323
Here is an example of the Modin-spreadsheet widget in action.
2424

25-
.. figure:: docs/images/overview_demo.gif
26-
:align: left
27-
:target: docs/images/overview_demo.gif
28-
:width: 200px
25+
.. figure:: docs/images/overview_demo.gif
26+
:align: left
27+
:target: docs/images/overview_demo.gif
28+
:width: 200px
2929

30-
A brief demo showing filtering, editing, history, and exporting the changed dataframe
30+
A brief demo showing filtering, editing, history, and exporting the changed dataframe
3131

3232
API Documentation
3333
-----------------
@@ -87,9 +87,11 @@ done when viewing DataFrames as a static html table. The following image shows
8787
multi-indexed DataFrame:
8888

8989
.. figure:: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
90-
:align: left
91-
:target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
92-
:width: 100px
90+
:align: left
91+
:target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
92+
:width: 100px
93+
94+
Disclaimer: This is from the Qgrid documentation.
9395

9496
**Events API**:
9597
The Events API provides ``on`` and ``off`` methods which can be used to attach/detach event handlers. They're available
@@ -113,22 +115,22 @@ Here are some examples of how the Events API can be applied.
113115

114116
This shows how you can use modin-spreadsheet to filter the data that's being shown by a matplotlib scatter plot:
115117

116-
.. figure:: docs/images/linked_to_scatter.gif
117-
:align: left
118-
:target: docs/images/linked_to_scatter.gif
119-
:width: 600px
118+
.. figure:: docs/images/linked_to_scatter.gif
119+
:align: left
120+
:target: docs/images/linked_to_scatter.gif
121+
:width: 600px
120122

121-
A brief demo showing modin-spreadsheet hooked up to a matplotlib plot
123+
A brief demo showing Modin-spreadsheet hooked up to a matplotlib plot. Disclaimer: This is from the Qgrid documentation.
122124

123125
This shows how events are recorded in real-time. The demo is recorded on JupyterLab, which is not yet supported, but
124126
the functionality is the same on Jupyter Notebook.
125127

126-
.. figure:: docs/images/events_api.gif
127-
:align: left
128-
:target: docs/images/events_api.gif
129-
:width: 600px
128+
.. figure:: docs/images/events_api.gif
129+
:align: left
130+
:target: docs/images/events_api.gif
131+
:width: 600px
130132

131-
A brief demo showing modin-spreadsheet's events api
133+
A brief demo showing Modin-spreadsheet's Events API. Disclaimer: This is from the Qgrid documentation.
132134

133135
Running from source & testing your changes
134136
------------------------------------------

0 commit comments

Comments
 (0)