Commit cde5428a authored by eric pellegrini's avatar eric pellegrini
Browse files

added class method to HDFViewer for opening the online documentation

updated the demo notebook accordingly
parent fc4cfa45
......@@ -14,10 +14,16 @@
```
%% Cell type:code id: tags:
``` python
HDFViewer.info()
```
%% Cell type:code id: tags:
``` python
path = PathSelector(extensions=[".hdf",".h5",".nxs"])
path.widget
```
%% Cell type:code id: tags:
......
import io
import os
import webbrowser
import numpy as np
......@@ -9,8 +10,8 @@ import matplotlib.pyplot as plt
import ipywidgets as widgets
import hdfviewer
from hdfviewer.viewers.MplDataViewer import MplDataViewer, MplDataViewerError
from hdfviewer.widgets.MplOutput import MplOutput
class HDFViewerError(Exception):
......@@ -147,3 +148,12 @@ class HDFViewer(widgets.Accordion):
hbox.children = [firstFrame,previousFrame,frame,nextFrame,lastFrame,plotMode]
display(hbox)
@classmethod
def info(self):
"""Open the url of the package documentation.
"""
# This will open the package documentation stored on readthedocs
url = os.path.join("https://hdf-viewer.readthedocs.io/en/{0}".format(hdfviewer.__release__))
webbrowser.open(url)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment