Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation #3699

Merged
merged 4 commits into from
Oct 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.insert(0, os.path.abspath('.'))
project = u'silx'
try:
import silx
project_dir = os.path.abspath(os.path.join(__file__, "..", "..", ".."))
build_dir = os.path.abspath(silx.__file__)
if not build_dir.startswith(project_dir):
raise RuntimeError("%s looks to come from the system. Fix your PYTHONPATH and restart sphinx." % project)
except ImportError:
raise RuntimeError("%s is not on the path. Fix your PYTHONPATH and restart sphinx." % project)
import silx

# Disable deprecation warnings:
# It avoid to spam documentation logs with deprecation warnings.
Expand Down
Binary file modified doc/source/modules/gui/data/img/ArrayTableWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/data/img/DataViewer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions doc/source/modules/gui/icons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ Available icons
- add-shape-polygon
* - |add-shape-rectangle|
- add-shape-rectangle
* - |add-shape-rotated-rectangle|
- add-shape-rotated-rectangle
* - |add-shape-unknown|
- add-shape-unknown
* - |add-shape-vertical|
Expand Down Expand Up @@ -315,6 +317,10 @@ Available icons
- rotate-3d
* - |rudder|
- rudder
* - |scale-auto|
- scale-auto
* - |scale-fixed|
- scale-fixed
* - |selected|
- selected
* - |shape-circle-solid|
Expand Down Expand Up @@ -421,6 +427,7 @@ Available icons
.. |add-shape-point| image:: ../../../../src/silx/resources/gui/icons/add-shape-point.png
.. |add-shape-polygon| image:: ../../../../src/silx/resources/gui/icons/add-shape-polygon.png
.. |add-shape-rectangle| image:: ../../../../src/silx/resources/gui/icons/add-shape-rectangle.png
.. |add-shape-rotated-rectangle| image:: ../../../../src/silx/resources/gui/icons/add-shape-rotated-rectangle.png
.. |add-shape-unknown| image:: ../../../../src/silx/resources/gui/icons/add-shape-unknown.png
.. |add-shape-vertical| image:: ../../../../src/silx/resources/gui/icons/add-shape-vertical.png
.. |add| image:: ../../../../src/silx/resources/gui/icons/add.png
Expand Down Expand Up @@ -554,6 +561,8 @@ Available icons
.. |rm| image:: ../../../../src/silx/resources/gui/icons/rm.png
.. |rotate-3d| image:: ../../../../src/silx/resources/gui/icons/rotate-3d.png
.. |rudder| image:: ../../../../src/silx/resources/gui/icons/rudder.png
.. |scale-auto| image:: ../../../../src/silx/resources/gui/icons/scale-auto.png
.. |scale-fixed| image:: ../../../../src/silx/resources/gui/icons/scale-fixed.png
.. |selected| image:: ../../../../src/silx/resources/gui/icons/selected.png
.. |shape-circle-solid| image:: ../../../../src/silx/resources/gui/icons/shape-circle-solid.png
.. |shape-circle| image:: ../../../../src/silx/resources/gui/icons/shape-circle.png
Expand Down
Binary file modified doc/source/modules/gui/plot/img/BasicGridStatsWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/plot/img/BasicStatsWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/plot/img/LimitsToolBar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/plot/img/ROIStatsWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/plot/img/logColorbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/plot3d/img/SceneWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/FrameBrowser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/HorizontalSliderWithBrowser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/PeriodicCombo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/PeriodicList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/PeriodicTable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/RangeSlider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/TableWidget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/ThreadPoolPushButton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/modules/gui/widgets/img/WaitingPushButton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions doc/source/sample_code/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,10 @@ Sample code that illustrates some functionalities of :class:`~silx.gui.plot.Plot

In this example a thread calls submitToQtMainThread to update the curve
of a plot.
* - :download:`plotUpdateImageFromGevent.py <../../../examples/plotUpdateImageFromGevent.py>`
- .. image:: img/plotUpdateImageFromGevent.png
:width: 150px
- This script illustrates the update of a :class:`~silx.gui.plot.Plot2D` widget from a gevent coroutine.
* - :download:`plotUpdateImageFromThread.py <../../../examples/plotUpdateImageFromThread.py>`
- .. image:: img/plotUpdateImageFromThread.png
:width: 150px
Expand Down