Merge pull request biolab#2868 from ajdapretnar/update-docs

Updated documentation + new template

.travis/build_doc.sh

@@ -30,4 +30,12 @@ cd $TRAVIS_BUILD_DIR/doc/data-mining-library
 make html
 cd $TRAVIS_BUILD_DIR/doc/visual-programming
 make html
-./build_widget_catalog.py --input build/html/index.html --output build/html/widgets.json --url-prefix "http://docs.orange.biolab.si/3/visual-programming/"
+
+# create widget catalog
+export PYTHONPATH=$TRAVIS_BUILD_DIR:$PYTHONPATH
+# Screen must be 24bpp lest pyqt5 crashes, see pytest-dev/pytest-qt/35
+XVFBARGS="-screen 0 1280x1024x24"
+catchsegv xvfb-run -a -s "$XVFBARGS" \
+    python $TRAVIS_BUILD_DIR/scripts/create_widget_catalog.py \
+        --output build/html/ \
+        --url-prefix "http://docs.orange.biolab.si/3/visual-programming/"

Orange/canvas/help/provider.py

@@ -226,4 +226,4 @@ def search(self, desc):
         if entry is not None:
             return self.inventory.resolved(QUrl(entry))
         else:
-            raise KeyError()
+            raise KeyError(desc.name.lower())

Orange/widgets/__init__.py

@@ -27,5 +27,5 @@ def widget_discovery(discovery):
     ("{DEVELOP_ROOT}/doc/visual-programming/build/htmlhelp/index.html", None),
 #     os.path.join(sysconfig.get_path("data"),
 #                  "share", "doc", "Orange-{}".format(Orange.__version__)),
-    ("http://docs.orange.biolab.si/3/visual-programming/", "")
+    ("https://docs.orange.biolab.si/3/visual-programming/", "")
 )

doc/visual-programming/source/_static/style.css

@@ -0,0 +1,37 @@
+p + dl {
+    border-top: 2px solid gray;
+    border-bottom: 2px solid gray;
+    padding: 12px;
+}
+
+p + dl dd:last-of-type {
+    margin-bottom: 0;
+}
+
+p + dl dt {
+    font-weight: bold;
+}
+
+p + dl dt::after {
+    content: ":";
+}
+
+dd dt {
+    font-weight: bold;
+    display: inline-block;
+}
+
+dd dt::after {
+    content: ":";
+}
+
+dd dd {
+    display: inline;
+    margin: 0;
+  }
+
+dd dd:after{
+    display: block;
+    content: '';
+  }
+

doc/visual-programming/source/conf.py

@@ -148,7 +148,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -367,3 +367,7 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
+
+
+def setup(app):
+    app.add_stylesheet('style.css')

doc/visual-programming/source/index.rst

@@ -62,7 +62,6 @@ Visualize
    widgets/visualize/scatterplot
    widgets/visualize/venndiagram
    widgets/visualize/linearprojection
-   widgets/visualize/scattermap
    widgets/visualize/sievediagram
    widgets/visualize/pythagoreantree
    widgets/visualize/pythagoreanforest

doc/visual-programming/source/widgets/data/color.rst

@@ -1,27 +1,16 @@
 Color
 =====
 
-.. figure:: icons/color.png
-
 Set color legend for variables. 
 
-Signals
--------
-
-**Inputs**:
-
--  **Data**
-
-   An input dataset. 
-
-**Outputs**:
-
-- **Data**
+Inputs
+    Data
+        input dataset
 
-   A dataset with a new color legend. 
+Outputs
+    Data
+        dataset with a new color legend
 
-Description
------------
 
 The **Color** widget enables you to set the color legend in your visualizations 
 according to your own preferences. This option provides you with the tools for 

doc/visual-programming/source/widgets/data/concatenate.rst

@@ -1,29 +1,18 @@
 Concatenate
 ===========
 
-.. figure:: icons/concatenate.png
-
 Concatenates data from multiple sources.
 
-Signals
--------
-
-**Inputs**:
-
--  **Primary Data**
-
-   A dataset that defines the attribute set.
-
--  **Additional Data**
-
-   An additional dataset.
-
-**Outputs**:
+Inputs
+    Primary Data
+        dataset that defines the attribute set
+    Additional Data
+        additional dataset
 
--  **Data**
+Outputs
+    Data
+        concatenated data
 
-Description
------------
 
 The widget concatenates multiple sets of instances (datasets). The
 merge is “vertical”, in a sense that two sets of 10 and 5 instances

doc/visual-programming/source/widgets/data/continuize.rst

@@ -1,27 +1,16 @@
 Continuize
 ==========
 
-.. figure:: icons/continuize.png
-
 Turns discrete attributes into continuous dummy variables.
 
-Signals
--------
-
-**Inputs**:
-
--  **Data**
-
-   Input dataset
-
-**Outputs**:
-
--  **Data**
+Inputs
+    Data
+        input dataset
 
-   Output dataset
+Outputs
+    Data
+        dataset with continuized instances
 
-Description
------------
 
 The **Continuize** widget receives a dataset in the input and outputs the
 same dataset in which the discrete attributes (including binary attributes)

doc/visual-programming/source/widgets/data/createclass.rst

@@ -1,27 +1,16 @@
 Create Class
 ============
 
-.. figure:: icons/create-class.png
-
 Create class attribute from a string attribute.
 
-Signals
--------
-
-**Inputs**:
-
--  **Data**
-
-   Attribute-valued dataset.
-
-**Outputs**:
-
--  **Data**
+Inputs
+    Data
+        input dataset
 
-   Attribute-valued dataset.
+Outputs
+    Data
+        dataset with a new class variable
 
-Description
------------
 
 **Create Class** creates a new class attribute from an existing discrete or string attribute. The widget matches the string value of the selected attribute and constructs a new user-defined value for matching instances.
 

doc/visual-programming/source/widgets/data/datainfo.rst

@@ -1,29 +1,12 @@
 Data Info
 =========
 
-.. figure:: icons/data-info.png
-
 Displays information on a selected dataset.
 
-Signals
--------
-
-**Inputs**:
-
--  **Data**
-
-   A dataset.
-
--  **Selected Data**
-
-   A data subset.
-
-**Outputs**:
-
--  (None)
+Inputs
+    Data
+        input dataset
 
-Description
------------
 
 A simple widget that presents information on dataset size, features,
 targets, meta attributes, and location. 

doc/visual-programming/source/widgets/data/datasampler.rst

@@ -1,32 +1,18 @@
 Data Sampler
 ============
 
-.. figure:: icons/data-sampler.png
-
 Selects a subset of data instances from an input dataset.
 
-Signals
--------
-
-**Inputs**:
-
--  **Data**
-
-   Input dataset to be sampled.
-
-**Outputs**:
-
--  **Data Sample**
-
-   A set of sampled data instances.
-
--  **Remaining Data**
+Inputs
+    Data
+        input dataset
 
-   All other data instances from the input dataset, which are not included in
-   the sample.
+Outputs
+    Data Sample
+        sampled data instances
+    Remaining Data
+        out-of-sample data
 
-Description
------------
 
 The **Data Sampler** widget implements several means of sampling data from
 an input channel. It outputs a sampled and a complementary

doc/visual-programming/source/widgets/data/datasets.rst

@@ -2,25 +2,12 @@
 Datasets
 ========
 
-.. figure:: icons/datasets.png
-
 Load a dataset from an online repository.
 
-Signals
--------
-
-**Inputs**:
-
--  (None)
-
-**Outputs**:
-
--  **Data**
-
-   Attribute-valued dataset.
+Outputs
+    Data
+        output dataset
 
-Description
------------
 
 **Datasets** widget retrives selected dataset from the server and sends it to the output. File is downloaded to the local memory and thus instantly available even without the internet connection. Each dataset is provided with a description and information on the data size, number of instances, number of variables, target and tags.