doc: rearranged website navigation to match the previous website

doc/src/conf.py

@@ -148,6 +148,9 @@ def autodoc_skip_member_callback(app, what, name, obj, skip, options):
 napoleon_attr_annotations = True
 
 # -- Options for HTML output -------------------------------------------------
+# disable page source generation
+html_copy_source = False
+html_show_source_link = False
 
 # base URL (also used to generate CNAME file by the ghpages extension)
 html_baseurl = 'https://simu5g.org'
@@ -159,6 +162,8 @@ def autodoc_skip_member_callback(app, what, name, obj, skip, options):
 extensions.append("sphinx_immaterial")
 html_theme = "sphinx_immaterial"
 html_css_files = ['sphinx-omnetpp.css',]
+html_logo = '_static/hero-banner.png'
+html_title = 'Simu5G: Simulator for 5G New Radio Networks'
 
 # material theme options (see theme.conf for more information)
 html_theme_options = {
@@ -171,22 +176,25 @@ def autodoc_skip_member_callback(app, what, name, obj, skip, options):
     "repo_url": "https://github.com/Unipisa/Simu5G",
     "repo_name": "Simu5G",
     # "edit_uri": "blob/site/doc/src",
-    "globaltoc_collapse": True,
+    "globaltoc_collapse": False,
+    "toc_title_is_page_title": True,
     "features": [
-        #"navigation.expand",
-        "navigation.tabs",
-        #"toc.integrate",
-        #"navigation.sections",
+        "announce.dismiss",
+        #"content.code.annotate",
+        "content.tabs.link",
+        #"header.autohide",
+        "navigation.expand",
         "navigation.instant",
-        # "header.autohide",
+        "navigation.sections",
+        "navigation.tabs",
+        #"navigation.tabs.sticky",
         "navigation.top",
-        "navigation.tracking",
+        #"navigation.tracking",
         "search.highlight",
         "search.share",
+        #"toc.integrate",
         "toc.follow",
         "toc.sticky",
-        "content.tabs.link",
-        "announce.dismiss",
     ],
     "palette": [
         {
@@ -220,7 +228,6 @@ def autodoc_skip_member_callback(app, what, name, obj, skip, options):
         },
     ],
     # END: version_dropdown
-    "toc_title_is_page_title": True,
     # BEGIN: social icons
     "social": [
         {

doc/src/contacts.rst

@@ -1,3 +1,4 @@
+:hide-footer:
 
 Contacts
 ========

doc/src/doc.rst

@@ -0,0 +1,32 @@
+:hide-toc:
+:hide-footer:
+
+
+User's Guide
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   users-guide/overview
+   users-guide/mec
+   users-guide/emulation
+   users-guide/emulation_openness
+
+Showcases
+---------
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   showcases/*/standalone/doc/index
+
+Tutorials
+---------
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   tutorials/*/doc/index

doc/src/faq.rst

@@ -1,3 +1,5 @@
+:hide-footer:
+
 Frequently Asked Questions
 ==========================
 
@@ -50,7 +52,7 @@ Frequently Asked Questions
    Yes and yes. More to the point, you can also run 5G
    simulations with ENDC deployments (i.e., a 4G eNB acting as a
    master and a 5G gNB acting as a slave). See the
-   :doc:`description <description>` page.
+   :doc:`users-guide/overview` page.
 
 .. question:: What hardware is required to run Simu5G as an emulator?
 

doc/src/index.rst

@@ -1,4 +1,42 @@
-:hero: 5G New Radio User Plane Simulation Model for INET & OMNeT++
+:hide-navigation:
+:hide-footer:
+
+.. toctree::
+   :caption: Home
+   :hidden:
+
+   self
+
+.. toctree::
+   :caption: Documentation
+   :hidden:
+
+   doc
+
+.. toctree::
+   :hidden:
+
+   install
+
+.. toctree::
+   :caption: FAQ
+   :hidden:
+
+   faq
+
+.. toctree::
+   :hidden:
+
+   related
+
+.. toctree::
+   :hidden:
+
+   contacts
+
+.. image:: _static/hero-banner.png 
+   :width: 700px
+   :align: center
 
 Simu5G: Simulator for 5G New Radio Networks
 ===========================================
@@ -46,6 +84,7 @@ Main Features
 
 .. figure:: images/capabilities.png
    :align: center
+   :width: 800px
 
 +-----------------------+-----------------------+--------------------------+
 | **User Terminals:**   | **g-NodeB:**          | **Network emulation:**   |
@@ -73,7 +112,7 @@ Main Features
 |                       | facilitate            |                          |
 |                       | cross-layer analysis. |                          |
 +-----------------------+-----------------------+--------------------------+
-| :doc:`ETSI MEC <users-guide/MEC>`:                                       |
+| :doc:`ETSI MEC <users-guide/mec>`:                                       |
 |                                                                          |
 | Model of both MEC system-level and host-level entities:                  |
 | UALCMP, MEC                                                              |
@@ -102,32 +141,3 @@ UniPi team:
    (`webpage <http://docenti.ing.unipi.it/a.virdis>`__)
 
 
-.. toctree::
-   :caption: Home
-   :hidden:
-
-   Introduction <self>
-   description
-   install
-   faq
-   related
-   contacts
-
-.. toctree::
-   :hidden:
-
-   users-guide/index
-
-.. toctree::
-   :hidden:
-   :glob:
-   :caption: Showcases
-
-   showcases/*/standalone/doc/index
-
-.. toctree::
-   :hidden:
-   :glob:
-   :caption: Tutorials
-
-   tutorials/*/doc/index

doc/src/install.rst

@@ -1,7 +1,7 @@
-:tocdepth: 2
+:hide-footer:
 
-Install Guide
-=============
+Installation
+============
 
 Prerequisites
 -------------

doc/src/related.rst

@@ -1,3 +1,5 @@
+:hide-footer:
+
 Publications
 ============
 
@@ -76,7 +78,6 @@ Simu5G.
    2016
 
 Related Publications
---------------------
 
 *(list in continuous updating)*
 

doc/src/description.rst → doc/src/users-guide/overview.rst

@@ -6,7 +6,7 @@ Features
 
 Simu5G is a 5G New Radio (NR) simulator based on the well-known
 `SimuLTE <https://simulte.omnetpp.org/>`__ library, developed by
-the same :doc:`research group <contacts>` and widely used by
+the same :doc:`research group <../contacts>` and widely used by
 industry and academia. Simu5G is based on the OMNeT++
 simulation framework, and provides a collection of models with
 well-defined interfaces, which can be instantiated and
@@ -35,7 +35,7 @@ allocation and management schemes in 5G networks, e.g.
 selecting which UEs to target, using which modulation scheme,
 etc., taking into account inter-cell interference coordination,
 carrier selection, energy efficiency and so on. Moreover,
-Simu5G can be run in :doc:`real-time emulation <users-guide/emulation>`
+Simu5G can be run in :doc:`real-time emulation <emulation>`
 mode, enabling interaction with real devices, thanks to
 OMNeT++'s real-time scheduling of events and INET's capability
 to exchange IP packets between local applications or network
@@ -46,7 +46,7 @@ live networked applications having an emulated 5G network in
 the middle, using the same codebase for both simulations and
 live prototyping.
 
-Simu5G also includes a :doc:`model of ETSI MEC <users-guide/MEC>`,
+Simu5G also includes a :doc:`model of ETSI MEC <mec>`,
 complete with models of MEC orchestrator, MEC platforms, MEC
 hosts and MEC services. In the latter, interfaces towards
 application endpoints (MEC app and Device app) are ETSI

doc/src/users-guide/basic.rst → doc/src/users-guide/wip.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 Introduction
 ============
 

showcases/NR/standalone/doc/index.rst

@@ -11,7 +11,7 @@ environment, and how traffic flows between these elements.
 
 .. versionadded:: 1.2.2
 
-| Source files location: `showcases/NR/standalone <https://github.com/Unipisa/Simu5G/tree/master/showcases/NR/standalone>`_
+| Source files location: `showcases/NR/standalone <https://github.com/Unipisa/Simu5G/tree/master/showcases/NR/standalone>`__
 
 Model
 -----

tutorials/NR/doc/index.rst

@@ -9,7 +9,7 @@ hints about the basic configurations of 5G NR networks.
 
 .. versionadded:: 1.2.2
 
-Source files location: `showcases/NR/standalone <https://github.com/Unipisa/Simu5G/tree/master/showcases/NR/standalone>`_
+Source files location: `showcases/NR/standalone <https://github.com/Unipisa/Simu5G/tree/master/showcases/NR/standalone>`__
 
 
 Introduction