This repository hosts the IT-Wallet Technical Specifications: the technical architecture, implementation framework and design requirements to be adopoted by the IT-Wallet System Technical Solutions.
For more information on the IT-Wallet System please refer to the official page.
The repository is structured as sphinx project tree. The first stable release is v1.0; older releases are considered experimental.
This project adheres to the Semantic Versioning model.
Furthermore, this project uses the git branches and tags in the following way:
- the branch
versione-correntecontains the last stable version of the documentation; - The release page of this project contains all the released versions of the specifications. For the sake of coherence, the releases are made according to the tag names.
Each time a release is created or edited, a preview is built based on the tag the release refers to.
A preview of the latest editor's copy build, corresponding to the branch versione-corrente can be navigated using the following link:
English version:
Versione Italiana:
This section contains the references about the official releases of this project.
Released versions are available in both Italian and English, and can be accessed in HTML and PDF formats.
| Version | English | Italian |
|---|---|---|
| 1.4.0 | HTML | PDF | HTML | PDF |
| 1.3.3 | HTML | PDF | HTML | PDF |
| 1.3.2 | HTML | PDF | HTML | PDF |
| 1.3.1 | HTML | PDF | HTML | PDF |
| 1.3.0 | HTML | PDF | HTML | PDF |
| 1.2.1 | HTML | PDF | HTML | PDF |
| 1.2.0 | HTML | PDF | HTML | PDF |
| 1.1.0 | HTML | PDF | HTML | PDF |
| 1.0.2 | HTML | PDF | HTML | PDF |
| 1.0.1 | HTML | PDF | HTML | PDF |
| v1.0.0 | HTML | HTML |
The following table contains all historical versions before 1.0.0, representing the early development stages of the IT-Wallet product:
| Version | English | Italian |
|---|---|---|
| v0.9.3 | HTML | HTML |
| v0.9.2 | HTML | HTML |
| v0.9.1 | HTML | HTML |
| v0.9.0 | HTML | HTML |
| v0.8.2 | HTML | HTML |
| v0.8.1 | HTML | HTML |
| v0.8.0 | HTML | HTML |
| v0.7.1 | HTML | HTML |
| v0.7.0 | HTML | HTML |
| v0.6.0 | HTML | HTML |
| v0.5.0 | HTML | HTML |
| v0.4.1 | HTML | HTML |
- access the manual build frontend
- insert the Pull Request number using the form and submit the workflow as shown in the image below.
pip install -r requirements-dev.txt
sphinx-build -b html -d html/en/doctrees docs/en/ html/en
ODT
sudo apt install pandoc
sphinx-build -b singlehtml docs/en/ html/
cd html
pandoc -o eid-it-wallet-docs.odt index.html
You can build the English and Italian PDFs locally using Docker, without installing LaTeX or Sphinx on your machine.
A prebuilt image is published on GitHub Container Registry as ghcr.io/italia/eidas-it-wallet-docs-builder.
- 1. Pull the image and tag it as
eid-wallet-it-docs
docker pull ghcr.io/italia/eidas-it-wallet-docs-builder:latest
docker tag ghcr.io/italia/eidas-it-wallet-docs-builder:latest eid-wallet-it-docsYou can also use a specific digest or tag shown on the package page, e.g.:
docker pull ghcr.io/italia/eidas-it-wallet-docs-builder:b235e366abbb852177eb2db39c9b2de2a7b71129
docker tag ghcr.io/italia/eidas-it-wallet-docs-builder:b235e366abbb852177eb2db39c9b2de2a7b71129 eid-wallet-it-docsFrom the repository root:
docker build -t eid-wallet-it-docs .From the repository root:
docker run --rm \
-e PDF_BUILD_TAG=1.4.0 \
-v "$PWD":/workspace \
-w /workspace \
eid-wallet-it-docs \
bash -lc "./utils/build-pdf-local.sh"This command:
- uses the
eid-wallet-it-docsimage (either pulled from GHCR and tagged, or built locally); - mounts the current repository into
/workspaceinside the container; - runs
./utils/build-pdf-local.sh, which for each language indocs/enanddocs/it:- builds LaTeX with Sphinx,
- compiles the main
.texfile with LuaLaTeX, - and copies the resulting PDFs into the
pdf_output/directory in your working tree.
Refer to Contributing Rules Section for an editorial guideline. Don't hesitate to submit Pull Requests or raise Issues if you encounter any problems.
These Technical Specifications are drafted and maintained by the Department for Digital Transformation, IPZS Istituto Poligrafico e Zecca dello Stato and PagoPA, with the supervision of AGID, Agency for Digital Italy.
The project is covered by a CC-0 license.