Issue 233 evaluate sphinx design (#240)

This PR contains a lot of cosmetic-only changes, as is replaces an extension (sphinx-panels) with a new one (sphinx-design) that builds on the former.
noi-techpark · Aug 31, 2021 · 2002a64 · 2002a64
1 parent f125cc0
commit 2002a64
Show file tree

Hide file tree

Showing 47 changed files with 1,307 additions and 1,167 deletions.
diff --git a/source/access-odh.rst b/source/access-odh.rst
@@ -33,78 +33,85 @@ methods to retrieve data.
 More in detail, these are the possibilities to interact with Open Data Hub's
 data by using a browser:
 
-.. panels::
-   :container: container-fluid pb-3
-   :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
-
-   Go to the :ref:`applist` section of the documentation,
-   particularly sub-sections :ref:`production-stage-apps` and
-   :ref:`beta-stage-apps`, and choose one of the web sites and
-   portals that are listed there. Each of them uses the data
-   gathered from one or more OPEN DATA HUB's datasets to display a
-   number of useful information. You can then see how data are
-   exposed and browse them.
-
-   ---
-
-   In the same :ref:`applist` section, you can also check the list
-   of the :strong:`Alpha Stage Apps` and choose one of them that
-   you think you can expand, then get in touch with the authors to
-   suggest additional features or collaborate with them to discuss
-   its further development to improve it.
-
-   ---
-
-   Access the `ODH Tourism data browser
-   <https://databrowser.opendatahub.bz.it/>`_ and search for the Open
-   Data available in the Tourism domain. You can simply use those
-   data for your convenience, or you might even find a novel way to
-   exploit those data and use them in an app or portal you are
-   going to develop. A detailed howto is available:
-   :ref:`tourism-data-browser-howto` to help you getting acquainted
-   with the browser.
-
-   ---
-
-   Go to the :strong:`Swagger interface` of the datasets in the
-   Tourism domain, located at
-   https://tourism.opendatahub.bz.it/swagger/ui/index to learn how
-   the REST APIs are built and how you can script them to fetch
-   data for your application. To get started, there is a dedicated
-   howto: :ref:`tourism-data-howto` that will guide you in the
-   first steps.
-
-   ---
-
-   Access the :strong:`Swagger interface` of the datasets in the
-   Mobility domain, located at
-   https://mobility.api.opendatahub.bz.it/. Like in the case of the
-   tourism' Swagger interface, you can learn REST API call for that
-   domain and fetch data for your application. More possibilities
-   to interact with the Mobility domain datasets and the
-   description of the new APIv2 are described in the
-   :ref:`dedicated howto <get-started-mobility>`.
-
-   ---
-
-   Open the :strong:`Analytics for Mobility` web page, at
-   https://analytics.opendatahub.bz.it/ This portal uses data in
-   the mobility domain to display various information about the
-   sensors, including their locations, what they measure, and
-   actual data in near-real time. You can retrieve data gathered by
-   the sensors directly from the dataset, in almost real-time.
-
-   ---
-   :column: col-12 p-2
-
-   Open the `Open Data Hub Knowledge Graph Portal
-   <https://sparql.opendatahub.bz.it/>`_ where you can explore all
-   the data that are already available as a virtual knowledge
-   graph. Here you can check out some of the precooked query to see
-   and modify them to suit your needs with the help of W3C's
-   `SPARQL query language
-   <https://www.w3.org/TR/sparql11-overview/>`_; SPARQL can be used
-   also in the `Playground` to freely query the endpoint.
+.. grid::
+   :gutter: 1
+
+   .. grid-item-card::
+      :columns: 4
+
+      Go to the :ref:`applist` section of the documentation,
+      particularly sub-sections :ref:`production-stage-apps` and
+      :ref:`beta-stage-apps`, and choose one of the web sites and
+      portals that are listed there. Each of them uses the data
+      gathered from one or more OPEN DATA HUB's datasets to display a
+      number of useful information. You can then see how data are
+      exposed and browse them.
+
+   .. grid-item-card::
+      :columns: 4
+
+      In the same :ref:`applist` section, you can also check the list
+      of the :strong:`Alpha Stage Apps` and choose one of them that
+      you think you can expand, then get in touch with the authors to
+      suggest additional features or collaborate with them to discuss
+      its further development to improve it.
+
+   .. grid-item-card::
+      :columns: 4
+
+      Access the `ODH Tourism data browser
+      <https://databrowser.opendatahub.bz.it/>`_ and search for the
+      Open Data available in the Tourism domain. You can simply use
+      those data for your convenience, or you might even find a novel
+      way to exploit those data and use them in an app or portal you
+      are going to develop. A detailed howto is available:
+      :ref:`tourism-data-browser-howto` to help you getting acquainted
+      with the browser.
+
+   .. grid-item-card::
+      :columns: 4
+
+      Go to the :strong:`Swagger interface` of the datasets in the
+      Tourism domain, located at
+      https://tourism.opendatahub.bz.it/swagger/ui/index to learn how
+      the REST APIs are built and how you can script them to fetch
+      data for your application. To get started, there is a dedicated
+      howto: :ref:`tourism-data-howto` that will guide you in the
+      first steps.
+
+   .. grid-item-card::
+      :columns: 4
+
+      Access the :strong:`Swagger interface` of the datasets in the
+      Mobility domain, located at
+      https://mobility.api.opendatahub.bz.it/. Like in the case of the
+      tourism' Swagger interface, you can learn REST API call for that
+      domain and fetch data for your application. More possibilities
+      to interact with the Mobility domain datasets and the
+      description of the new APIv2 are described in the
+      :ref:`dedicated howto <get-started-mobility>`.
+
+   .. grid-item-card::
+      :columns: 4
+
+      Open the :strong:`Analytics for Mobility` web page, at
+      https://analytics.opendatahub.bz.it/ This portal uses data in
+      the mobility domain to display various information about the
+      sensors, including their locations, what they measure, and
+      actual data in near-real time. You can retrieve data gathered by
+      the sensors directly from the dataset, in almost real-time.
+
+   .. grid-item-card::
+
+
+      Open the `Open Data Hub Knowledge Graph Portal
+      <https://sparql.opendatahub.bz.it/>`_ where you can explore all
+      the data that are already available as a virtual knowledge
+      graph. Here you can check out some of the precooked query to see
+      and modify them to suit your needs with the help of W3C's
+      `SPARQL query language
+      <https://www.w3.org/TR/sparql11-overview/>`_; SPARQL can be used
+      also in the `Playground` to freely query the endpoint.
 
 Programmatic access
 -------------------
@@ -113,40 +120,49 @@ Programmatic and non-interactive access to the Open Data Hub's dataset
 is possible using any of the following methods made  available
 by the |odh| team.
 
-.. panels::
-   :container: container-fluid
+.. grid::
+   :gutter: 1
 
-   .. _ab-access:
+
+   .. grid-item-card:: 
+      :columns: 6
 
-   AlpineBits client
-   ^^^^
-   .. include:: /includes/AlpineBits.rst
+      .. _ab-access:
 
-   ----
+      AlpineBits client
+      ^^^^^^^^^^^^^^^^^
+      .. include:: /includes/AlpineBits.rst
 
-   .. _r-access:
+   .. grid-item-card::
+      :columns: 6
 
-   Statistical Access with R
-   ^^^^
-   .. include:: /includes/R.rst
+      .. _r-access:
 
-   ---
-   .. _ninja api:
+      Statistical Access with R
+      ^^^^^^^^^^^^^^^^^^^^^^^^^
+
+      .. include:: /includes/R.rst
 
-   API
-   ^^^^
+   .. grid-item-card::
+      :columns: 6
+
+      .. _ninja api:
 
-   .. include:: /includes/API.rst
+      API
+      ^^^
+
+      .. include:: /includes/API.rst
 
-   ---
+   .. grid-item-card::
+      :columns: 6
+
+      .. _cli-access:
 
-   .. _cli-access:
-
-   CLI access
-   ^^^^
-
-   .. include:: /includes/CLI.rst
+      CLI access
+      ^^^^^^^^^^
+      .. include:: /includes/CLI.rst
 
 .. odh vkg km
 
 .. include:: /includes/kg.rst
+
diff --git a/source/applist.rst b/source/applist.rst
@@ -97,24 +97,28 @@ hackathons and must be considered as `Experimental`. |alpha|
 
 .. rubric::  Year 2018
 
-.. tabbed:: Summer Lido Hackathon
+.. tab-set::
 
-   .. include:: /apps/summerlido2018.rst
+   .. tab-item:: Summer Lido Hackathon
 
-.. tabbed:: HackTheAlps
+      .. include:: /apps/summerlido2018.rst
 
-   .. include:: /apps/hackthealps2018.rst
+   .. tab-item:: HackTheAlps
 
-.. tabbed:: Vertical Innovation Hackathon
+      .. include:: /apps/hackthealps2018.rst
 
-   .. include:: /apps/verticalinnovation2018.rst
+   .. tab-item:: Vertical Innovation Hackathon
+
+      .. include:: /apps/verticalinnovation2018.rst
 
 .. rubric:: Year 2019
 
-.. tabbed:: NOI Hackathon Summer edition
+.. tab-set::
+
+   .. tab-item:: NOI Hackathon Summer edition
 
-   .. include:: /apps/summerlido2019.rst
+      .. include:: /apps/summerlido2019.rst
 
-.. tabbed:: NOI Hackathon SFScon Edition
+   .. tab-item:: NOI Hackathon SFScon Edition
 
-   .. include:: /apps/sfscon2019.rst
+      .. include:: /apps/sfscon2019.rst
diff --git a/source/changelog.rst b/source/changelog.rst
@@ -183,11 +183,19 @@ documentation.
 
       Add statistics about Tourism's Open Data and CC0-licensed images
 
-
    .. change::
       :tags: Improvement
       :tickets: 221
 
       Rearrange subsections in sections :ref:`data-access` and
       :ref:`available_datasets`, add a new FAQ entry and reformat FAQ
       section.
+
+   .. change::
+      :tags: Improvement
+      :tickets: 233
+
+      The `sphinx-panels
+      <https://github.com/executablebooks/sphinx-panels>`_ extension
+      has been replaced by its successor, `sphinx-design
+      <https://github.com/executablebooks/sphinx-design>`_.
diff --git a/source/conf.py b/source/conf.py
@@ -29,7 +29,7 @@
     'sphinx.ext.extlinks',
     'sphinx.ext.imgconverter',
     'ga', 'hidemail',
-    'sphinx_togglebutton', 'sphinx_panels',
+    'sphinx_togglebutton', 'sphinx_design',
     'sphinx_copybutton', 'changelog'
 ]