Merge pull request #160 from noi-techpark/issue-136

Issue 136
noi-techpark · Aug 19, 2020 · 9ac0e30 · 9ac0e30
2 parents 178249a + 741fbec
commit 9ac0e30
Show file tree

Hide file tree

Showing 12 changed files with 120 additions and 181 deletions.
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,4 @@
 sphinx-tabs==1.1.13
 Sphinx==2.2.1
+sphinx_panels==0.4.0
+sphinx-tooglebutton==0.2.0
diff --git a/source/applist.rst b/source/applist.rst
@@ -1,10 +1,10 @@
 .. _applist:
 
-Apps built from |ODH| datasets
-==============================
+Apps Built From Open Data Hub Datasets
+======================================
 
 This section features a list of applications--and their
-descriptions--built using the :doc:`datasets` that the |odh| team
+descriptions--built using the :doc:`datasets` that the Open Data Hub team
 makes available.
 
 Applications are grouped according to their status in three categories:
@@ -22,7 +22,7 @@ Applications are grouped according to their status in three categories:
   a production environment.
 
 If you are developing one application with the data provided by
-datasets of the |odh| project, send an email with a short description,
+datasets of the Open Data Hub project, send an email with a short description,
 an email contact and its status and we'll add it to the list.
 
 .. _production-stage-apps:
@@ -95,61 +95,44 @@ Alpha Stage Apps
 All the projects listed in this section have been built during various
 hackathons and must be considered as `Experimental`. |alpha|
 
-.. only:: html
 
-   * Year 2018
+.. rubric::  Year 2018
 
-   .. tabs::
+.. panels::
+   :container: container-lg pb-3
+   :column: col-sm-4
 
-      .. tab:: Summer Lido Hackathon 2018 
+   .. toggle:: Summer Lido Hackathon 
 
-	 .. include:: /apps/summerlido2018.rst
+      .. include:: /apps/summerlido2018.rst
 
-      .. tab:: HackTheAlps 2018
-
-	 .. include:: /apps/hackthealps2018.rst
-
-      .. tab:: Vertical Innovation Hackathon 2018 
-
-	 .. include:: /apps/verticalinnovation2018.rst
-
-   * Year 2019
-
-   .. tabs::
-
-      .. tab:: NOI Hackathon Summer edition 2019
-
-	 .. include:: /apps/summerlido2019.rst
-
-      .. tab:: NOI Hackathon SFScon Edition 2019
+   -----
+
+   .. toggle:: HackTheAlps
+
+      .. include:: /apps/hackthealps2018.rst
+
+   -----
+
+   .. toggle:: Vertical Innovation Hackathon
 
-	 .. include:: /apps/sfscon2019.rst
-
+      .. include:: /apps/verticalinnovation2018.rst
 
-.. only:: latex or latexpdf or epub
 
-   Summer Lido Hackathon 2018 |alpha|
-   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-   .. include:: /apps/summerlido2018.rst
+.. rubric:: Year 2019
 
-   HackTheAlps 2018 |alpha|
-   ~~~~~~~~~~~~~~~~~~~~~~~~
-
-   .. include:: /apps/hackthealps2018.rst
+.. panels::
+   :container: container-lg pb-3
+   :column: col-sm-6
+
+   .. toggle:: NOI Hackathon Summer edition 
 
-   Vertical Innovation Hackathon 2018
-   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+      .. include:: /apps/summerlido2019.rst
 
-   .. include:: /apps/verticalinnovation2018.rst
-
-   Summer Lido Hackathon 2019 |alpha|
-   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   -----
 
-   .. include:: /apps/summerlido2019.rst
-
-   NOI Hackathon SFScon Edition 2019
-   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   .. toggle:: NOI Hackathon SFScon Edition 
 
-   .. include:: /apps/sfscon2019.rst
+      .. include:: /apps/sfscon2019.rst
 
diff --git a/source/conf.py b/source/conf.py
@@ -28,10 +28,14 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.extlinks',
     'sphinx.ext.imgconverter',
-    'sphinx_tabs.tabs',
-    'ga', 'hidemail'
+    'ga', 'hidemail',
+    'sphinx_togglebutton', 'sphinx_panels'
 ]
 
+### Configuration values for extensions
+
+togglebutton_hint = "More..."
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/source/datasets.rst b/source/datasets.rst
@@ -65,7 +65,7 @@ The Open Data Hub\'s Data Providers are:
 * Südtirol Wein.
 * Route220, Nevicam and Driwe e-charging stations provider
 
-.. topic:: A note about datasets.
+.. topic:: A note about datasets
 
    The Open Data Hub contains many datasets: a few have been provided for
    testing purposes, other are meant for internal use only, and other

diff --git a/source/howto.rst b/source/howto.rst
@@ -7,92 +7,54 @@ This page contains the list of available howtos, divided into
 areas. The list of howtos, together with a short description is
 available here:
 
-.. only:: html
-
-   .. tabs::
-
-      .. tab:: Mobility
-
-	 #. :doc:`/howto/mobility/getstarted` Getting started with the
-	    new API v2.
-	 #. :doc:`/howto/mobility/mobility`. Since the APIs are very generic,
-	    directions contained in this howto can be applied to any
-	    dataset of the mobility domain.
-	 #. :doc:`/howto/mobility/mobilityanalytics`. This howto guides you in
-	    browse and query data produces from the sensors used in
-	    the mobility domain.
-
-      .. tab:: Tourism
-
-	 #. :doc:`/howto/tourism/getstarted` Description of how to
-	    access and manipulate data, the input data used, and the
-	    various filters available in the Tourism domain.
-	 #. :doc:`/howto/tourism/browse` Access to the open data
-	    provided within the Tourism domain.
-	 #. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and
-	    use cases for data in the Tourism domain.
 
+.. panels::
+
+   .. toggle:: Mobility
+
+      #. :doc:`/howto/mobility/getstarted` Getting started with the
+	 new API v2.
+      #. :doc:`/howto/mobility/mobility`. Since the APIs are very
+	 generic, directions contained in this howto can be applied to
+	 any dataset of the mobility domain.
+      #. :doc:`/howto/mobility/mobilityanalytics`. This howto guides you in
+	 browse and query data produces from the sensors used in
+	 the mobility domain.
+
+   -----
+
+   .. toggle:: Tourism
+
+      #. :doc:`/howto/tourism/getstarted` Description of how to
+	 access and manipulate data, the input data used, and the
+	 various filters available in the Tourism domain.
+      #. :doc:`/howto/tourism/browse` Access to the open data
+	 provided within the Tourism domain.
+      #. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and
+	 use cases for data in the Tourism domain.
+
+   -----
+   :column: col-sm-12
 
-      .. tab:: Miscellaneous
-
-
-	 #. :doc:`/howto/authentication` Access to data that are not yet open
-	    (mostly for internal use).
-
-	 #. :doc:`/howto/development` Set up your workstation to
-	    develop for |odh|--This tutorial is still in development
-	    and not so useful at the moment!
-
-	 #. :doc:`/howto/postman` Setup of Postman, a popular API
-	    development environment, to access data from the |odh|.
+   .. toggle:: Miscellaneous
+
 
-	 #. :doc:`/howto/noievents` Create and modify NOI events
-	    directly from the |odh| portal.
+      #. :doc:`/howto/authentication` Access to data that are not yet open
+	 (mostly for internal use).
 
-	 #. :doc:`/howto/webcomponents` share your Web Components with
-	    |odh| team
+      #. :doc:`/howto/development` Set up your workstation to
+	 develop for Open Data Hub--This tutorial is still in development
+	 and not so useful at the moment!
 
+      #. :doc:`/howto/postman` Setup of Postman, a popular API
+	 development environment, to access data from the Open Data Hub.
 
-.. only:: latex or latexpdf or epub
+      #. :doc:`/howto/noievents` Create and modify NOI events
+	 directly from the Open Data Hub portal.
 
-   .. rubric:: Mobility
+      #. :doc:`/howto/webcomponents` share your Web Components with
+	 Open Data Hub team
 
-   #. :doc:`/howto/mobility/getstarted` Getting started with the new
-      API v2.
-   #. :doc:`/howto/mobility/mobility`. Since the APIs are very
-      generic, directions contained in this howto can be applied to
-      any dataset of the mobility domain.
-   #. :doc:`/howto/mobility/mobilityanalytics`. This howto guides you in browse
-      and query data produces from the sensors used in the mobility
-      domain.
-
-   .. rubric:: Tourism
-
-   #. :doc:`/howto/tourism/getstarted` Description of how to access
-      and manipulate data, the input data used, and the various
-      filters available in the Tourism domain.
-   #. :doc:`/howto/tourism/browse` Access to the open data provided
-      within the Tourism domain.
-   #. :doc:`/howto/tourism/tips` Mini howtos, tricks&tips, and use
-      cases for data in the Tourism domain.
-
-   .. rubric:: Miscellaneous
-
-   #. :doc:`/howto/authentication` Access to data that are not yet
-      open (mostly for internal use).
-
-   #. :doc:`/howto/development` Set up your workstation to develop for
-      |odh|--This tutorial is still in development and not so useful
-      at the moment!
-
-   #. :doc:`/howto/postman` Setup of Postman, a popular API
-      development environment, to access data from the |odh|.
-
-   #. :doc:`/howto/noievents` Create and modify NOI events directly
-      from the |odh| portal.
-
-   #. :doc:`/howto/webcomponents` share your webcomponents with
-      |odh| team
 
 .. toctree::
    :maxdepth: 1

diff --git a/source/includes/appdevel.rst b/source/includes/appdevel.rst
@@ -15,20 +15,20 @@
    documentation, and the datasets. It is then your task to discover
    how you can reuse the data in your code.
 
-...integrate |odh| data using Web Components.
-   The |ODH| team and their partner have developed a `small library of
+...integrate Open Data Hub data using Web Components.
+   The Open Data Hub team and their partner have developed a `small library of
    Web Components <https://webcomponents.opendatahub.bz.it/>`_ that can
    be integrated in existing web sites or used as guidance to develop
    new Web Components.
 
-...publish my app in |odh|.
+...publish my app in Open Data Hub.
    As soon as you have developed a stable version of your app, get in
    touch with us: We plan to maintain an updated list of apps based on
    our dataset included with this documentation.
 
 
 No software installation is needed: Go to the list of :ref:`available
-applications developed by third-parties <applist>` that use |odh|
+applications developed by third-parties <applist>` that use Open Data Hub
 data, to the API documentation of each :ref:`Dataset
 <available_datasets>` and start from there, and develop in a language
 of your choice an application that uses our data.
diff --git a/source/includes/bugrepo.rst b/source/includes/bugrepo.rst
@@ -23,7 +23,7 @@ suits your needs:
 5. `Leave your feedback <https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fnoi-techpark%2Fodh-docs%2Fissues%2Fnew%3Ftemplate%3Dfeedback.md>`_
 
 .. note:: You need to have a valid github account to report issues and
-   interact with the |odh| team.
+   interact with the Open Data Hub team.
 
 We keep track of your reports in our bug trackers, where you can also
-follow progress and comments of the |odh| team members.
+follow progress and comments of the Open Data Hub team members.
diff --git a/source/includes/corehacker.rst b/source/includes/corehacker.rst
@@ -1,6 +1,6 @@
 
-...help shape the future of |odh|\.
-   Participate in the development of |odh|\ : Build new data
+...help shape the future of Open Data Hub.
+   Participate in the development of Open Data Hub: Build new data
    collectors, extend the functionality of the broker, integrate new
    datasets on the existing infrastructure, develop new stable API
    versions.   
@@ -11,7 +11,7 @@ tasks to be carried out:
 
 
 #. Learn how to successfully integrate your code with the existing
-   code-base and how to interact with the |odh| team.  In other words,
+   code-base and how to interact with the Open Data Hub team.  In other words,
    you need to read and accept the :ref:`devel-guidelines` (click on
    the link for a summary), which are available in two extended,
    separate parts: :ref:`platform-guidelines` and

diff --git a/source/includes/dataproviders.rst b/source/includes/dataproviders.rst
@@ -1,7 +1,7 @@
-...provide Open Data to the |odh| project.
+...provide Open Data to the Open Data Hub project.
    Share with an Open Data Licence (like e.g., |cc0| or |bysa|) the
-   data you own, that can prove interesting for the |odh|\, for
-   example because they complement existing data in the |odh| or they
+   data you own, that can prove interesting for the Open Data Hub, for
+   example because they complement existing data in the Open Data Hub or they
    pertain to an area which is not yet covered. Let your Open Data be
    freely used by App Developers in their applications.
 

diff --git a/source/includes/user.rst b/source/includes/user.rst
@@ -1,7 +1,7 @@
 
 ...install and use an app built on top of the API.
    Browse the list of :ref:`available applications developed by
-   third-parties <applist>` that use |odh| data, choose one that you
+   third-parties <applist>` that use Open Data Hub data, choose one that you
    are interested in, install it and try it out, then send feedback to
    their developers if you feel something is wrong or missing.
 
@@ -13,5 +13,5 @@
    improvements or new features, and so on.
 
    Moreover, if you are interested in datasets that are not yet in our
-   collection, get in touch with the |odh| team to discuss your
+   collection, get in touch with the Open Data Hub team to discuss your
    request.