Template

README.md

@@ -64,7 +64,7 @@ HTML
 ````
 pip install -r requirements.txt
 
-sphinx-build -b html -d html/en/doctrees docs/en/  html/en
+sphinx-build -b html -d html/en/doctrees docs/en/ html/en
 ````
 
 ODT

docs/common/common_definitions.rst

@@ -1,25 +1,3 @@
-.. commenti
-   `[...]`_
-   ’
-   “”
-
-.. |br| raw:: html
-
-   <br/>
-
-.. |check-icon| image:: ../../images/Eo_circle_green_checkmark.svg
-   :width: 25
-
-.. |partially-check-icon| image:: ../../images/Eo_circle_orange_checkmark.svg
-   :width: 25
-
-.. |uncheck-icon| image:: ../../images/Eo_circle_red_letter-x.svg
-   :width: 25
-
-
-.. |warning-message-it| replace:: Tutti gli esempi contenuti in questa documentazione sono da intendersi come non normativi
-.. |warning-message-en| replace:: All the examples contained in this documentation are meant to be non-normative
-
 .. _OAuthCrossDeviceSec: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-cross-device-security-08
 .. _OpenID4VC-SecTrust: https://openid.github.io/OpenID4VC_SecTrust/draft-oid4vc-security-and-trust.html
 .. _OID-FED: https://openid.net/specs/openid-federation-1_0-41.html

docs/common/symbols.rst

@@ -0,0 +1,11 @@
+.. |check-icon| image:: ../../images/Eo_circle_green_checkmark.svg
+   :width: 25
+
+.. |partially-check-icon| image:: ../../images/Eo_circle_orange_checkmark.svg
+   :width: 25
+
+.. |uncheck-icon| image:: ../../images/Eo_circle_red_letter-x.svg
+   :width: 25
+
+.. |warning-message-it| replace:: Tutti gli esempi contenuti in questa documentazione sono da intendersi come non normativi
+.. |warning-message-en| replace:: All the examples contained in this documentation are meant to be non-normative

docs/en/authentic-sources.rst

@@ -1,12 +1,11 @@
 .. include:: ../common/common_definitions.rst
 
-
 Authentic Sources
 +++++++++++++++++++
 
 Authentic Sources provide Users attributes to the Credential Issuers enabling them in the issuance of the Digital Credentials. During the Issuance Flow, Credential Issuers request from Authentic Sources the attributes required to provide the requested Credential. Authentic Sources MAY also provide a Credential Offer related to their Credential Issuers as defined in Section :ref:`Credential Offer Endpoint <Credential Offer Endpoint>`.
 
-Public Authentic Sources MUST interact with Credential Issuers via PDND according to the rules defined in Section :ref:`e-Service PDND <e-service-pdnd>` and in Section :ref:`Status Update by Authentic Sources <Status Update by Authentic Sources>`. See also Section :ref:`Authentic Source Catalogue <Authentic Source Catalogue>` for additional details.
+Public Authentic Sources MUST interact with Credential Issuers via PDND according to the rules defined in Section :ref:`e-Service PDND <e-service-pdnd>` and in Section :ref:`Status Update by Authentic Sources <Status Update by Authentic Sources>`. See also Section :ref:`Authentic Source Catalogue <authentic_sopurce_catalogue>` for additional details.
 
 Authentic Sources MUST:
 
@@ -17,3 +16,5 @@ Authentic Sources MUST:
 
     - cooperate with their Credential Issuers so that the attributes attested in a Digital Credential are always kept up to date. Public Authentic Sources MUST use PDND to notify their Credential Issuers of any update regarding attributes that have changed or are no longer valid. 
 
+.. include:: e-service-pdnd.rst
+.. include:: e-service-pdnd-catalogue.rst

docs/en/conf.py

@@ -2,29 +2,27 @@
 # -*- coding: utf-8 -*-
 
 # -- PROJECT Variables ----------------------------------------------------
-settings_project_name = "The Italian EUDI Wallet implementation profile"
+settings_project_name = "Italian EUDI Wallet Implementation Profile"
 # settings_copyright_copyleft = 'Dipartimento per la Trasformazione Digitale'
 settings_editor_name = 'Dipartimento per la Trasformazione Digitale'
 settings_doc_version = 'version: latest'
 settings_doc_release = 'version: latest'
 settings_basename = 'eidas-it-wallet-docs'
 settings_file_name = 'eidas-it-wallet-docs'
 
-# -- No need to change below here
-
 import sys, os
 from recommonmark.transform import AutoStructify
 from recommonmark.parser import CommonMarkParser
 
-# -- RTD configuration ------------------------------------------------
+# -- RTD configuration -------------------------------------------------
 
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 # This is used for linking and such so we link to the thing we're building
 rtd_version = os.environ.get('READTHEDOCS_VERSION', 'latest')
 if rtd_version not in ['stable', 'latest']:
-    rtd_version = 'stable'
+    rtd_version = 'latest'
 
 rtd_project = os.environ.get('READTHEDOCS_PROJECT', '')
 
@@ -96,9 +94,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = settings_doc_version
+#  version = settings_doc_version
 # The full version, including alpha/beta/rc tags.
-release = settings_doc_release
+#  release = settings_doc_release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -137,47 +135,53 @@ def setup(app):
 html_theme_options = {
     # This option can be used with docs-italia-theme to customise how the versions "badge" is shown:
     # 'False': default (alabaster) badge | 'True': custom (italia) badge
-    'custom_versions_badge': 'True',
-    'collapse_navigation': 'True',
+    # 'custom_versions_badge': True,
+    'collapse_navigation': True,
     "show_theme_credit": False,
     "source_url": 'https://github.com/italia/eudi-wallet-it-docs',
-    "source_icon": "gitlab",
+    "source_icon": "github",
+    # "banner_text": 'We just launched a newletter, <a href="https://mynewsletter.com/">please subscribe</a>!'
 }
 
 # -- ReadTheDoc requirements and local template generation---------------------
 
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+#  on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-if not on_rtd:  # only import and set the theme if we're building docs locally
+#  if not on_rtd:  # only import and set the theme if we're building docs locally
     #  html_theme_path = [docs_italia_theme.get_html_theme_path()]
     #  html_theme = 'docs_italia_theme'
-    pass
-else:
-    # Override default css to get a larger width for ReadTheDoc build
-    html_context = {
-        'css_files': [
-            '_static/css/theme.css',
-            '_static/css/badge_only.css',
-        ],
-    }
+    #  pass
+#  else:
+    #  # Override default css to get a larger width for ReadTheDoc build
+    #  html_context = {
+        #  'css_files': [
+            #  '_static/css/theme.css',
+            #  '_static/css/badge_only.css',
+            #  '_static/css/itwallet-override.css' # div#top_nav nav { background-color: #0066CC } actually #3889CE
+        #  ],
+    #  }
+
+html_css_files = [
+    "itwallet-override.css"
+]
 
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = settings_project_name
+#  html_title = "Ciao" #settings_project_name
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+#  html_short_title = "IT-Wallet"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "https://avatars.githubusercontent.com/u/15377824?s=48&v=4"
+#  html_logo = "https://avatars.githubusercontent.com/u/15377824?s=48&v=4"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = "https://avatars.githubusercontent.com/u/15377824?s=48&v=4"
 
 # 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,
@@ -274,7 +278,6 @@ def setup(app):
 # If false, no module index is generated.
 #latex_domain_indices = True
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -296,7 +299,8 @@ def setup(app):
 texinfo_documents = [
   ('index', settings_file_name, settings_project_name,
    settings_project_name, settings_project_name,
-   'Miscellaneous'),
+   'Miscellaneous'
+  )
 ]
 
 numfig = True

docs/en/defined-terms.rst

@@ -127,7 +127,7 @@ Below are the description of acronyms and definitions which are useful for furth
      - Positive outcome of Trust Evaluation, which produces a reliable relationship between Organizational Entities, where one Organizational Entity trusts the other to securely handle data, execute transactions, or perform actions on its behalf.
      -
    * - Metadata
-     - Digital artifact that contains all the required information about an Organizational Entity, e.g., protocol related endpoints and the Organizational Entity’s cryptographic public keys (for the complete list check requirement “Metadata Content”).
+     - Digital artifact that contains all the required information about an Organizational Entity, e.g., protocol related endpoints and the Organizational Entity’s cryptographic public keys (for the complete list check requirement "Metadata Content").
      -
    * - Policy Language
      - A formal language used to define security, privacy, and identity management policies that govern interactions and transactions within a Trust Framework. This language allows for the clear and unambiguous expression of rules and conditions, facilitating the automation of processes and interoperability among different systems and organizations.

docs/en/e-service-pdnd-catalogue.rst

@@ -4,10 +4,10 @@
    :format: html
 
 e-Service PDND Catalogue
-========================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Credential Issuer Catalogue
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Credential Issuers MUST provide the following e-services through PDND to:
 
@@ -19,7 +19,8 @@ Credential Issuers MUST provide the following e-services through PDND to:
     A complete OpenAPI Specification is available :raw-html:`<a href="OAS3-PDND-Issuer.html" target="_blank">here</a>`.
 
 Notify Available Credential
-+++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. list-table::
     :widths: 20 80 
     :stub-columns: 1
@@ -33,7 +34,7 @@ Notify Available Credential
       - Authentic Source
 
 Notify Update Credential
-++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. list-table::
     :widths: 20 80 
@@ -51,7 +52,7 @@ Notify Update Credential
 
 
 Notify Wallet Instance Revocation
-++++++++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. list-table::
     :widths: 20 80 
@@ -66,7 +67,7 @@ Notify Wallet Instance Revocation
       - Wallet Provider
 
 Get Statistics
-++++++++++++++++++++++++++++++++++
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. list-table::
     :widths: 20 80 
@@ -79,7 +80,9 @@ Get Statistics
     * - **Consumer**
       - Authorized Third Party 
 
+.. _authentic_sopurce_catalogue:
 
 Authentic Source Catalogue
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+...