Skip to content

Commit a4d328f

Browse files
committed
Reorganized reference documentation
1 parent 17e5e25 commit a4d328f

24 files changed

+91
-64
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.spyderproject
22
qwt-6.1.2
33
qwt/tests/demo.png
4-
qwtdoc.chm
4+
python-qwtdoc.chm
55

66
# Created by https://www.gitignore.io/api/python
77

build_chm.bat

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
sphinx-build -b htmlhelp doc doctmp
2-
"C:\Program Files\HTML Help Workshop\hhc.exe" doctmp\qwtdoc.hhp
3-
"C:\Program Files (x86)\HTML Help Workshop\hhc.exe" doctmp\qwtdoc.hhp
4-
copy doctmp\qwtdoc.chm .
2+
"C:\Program Files\HTML Help Workshop\hhc.exe" doctmp\python-qwtdoc.hhp
3+
"C:\Program Files (x86)\HTML Help Workshop\hhc.exe" doctmp\python-qwtdoc.hhp
4+
copy doctmp\python-qwtdoc.chm .
55
rmdir /S /Q doctmp
66
pause

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
#html_file_suffix = ''
169169

170170
# Output file base name for HTML help builder.
171-
htmlhelp_basename = 'qwtdoc'
171+
htmlhelp_basename = 'python-qwtdoc'
172172

173173

174174
# -- Options for LaTeX output --------------------------------------------------

doc/reference/color_map.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

doc/reference/index.rst

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
11
Reference
22
=========
33

4-
Main `python-qwt` classes:
4+
Public API:
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
9+
plot
10+
scale
11+
symbol
12+
text
13+
toqimage
14+
15+
Private API:
516

617
.. toctree::
718
:maxdepth: 2
819

9-
color_map
1020
graphic
1121
interval
12-
legend
1322
legend_data
1423
legend_label
15-
plot
16-
plot_canvas
17-
plot_curve
1824
plot_directpainter
19-
plot_grid
2025
plot_layout
21-
plot_marker
22-
plot_renderer
2326
plot_seriesitem
24-
scale_div
25-
scale_draw
26-
scale_engine
27-
scale_widget
2827
series_data
2928
series_store
30-
symbol
31-
text
32-
text_engine
3329
transform
34-
toqimage

doc/reference/legend.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

doc/reference/plot.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1+
Plot widget fundamentals
2+
------------------------
3+
14
.. automodule:: qwt.plot
25
:members:
6+
7+
.. automodule:: qwt.plot_canvas
8+
:members:
9+
10+
Plot items
11+
----------
12+
13+
.. automodule:: qwt.plot_grid
14+
:members:
15+
16+
.. automodule:: qwt.plot_curve
17+
:members:
18+
19+
.. automodule:: qwt.plot_marker
20+
:members:
21+
22+
Additional plot features
23+
------------------------
24+
25+
.. automodule:: qwt.legend
26+
:members:
27+
28+
.. automodule:: qwt.color_map
29+
:members:
30+
31+
.. automodule:: qwt.plot_renderer
32+
:members:

doc/reference/plot_canvas.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

doc/reference/plot_curve.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

doc/reference/plot_grid.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)