This repository hosts the sphinx project tree of IT-Wallet Technical Specifications.
This repository may contain contents to be considered experimental until the publication of the first stable release, v1.0.
The stable release in different languages is published at the link below:
Preview of other branches can be navigated by adding the branch name in the webpath, as follows:
Released versions can be navigated by adding the tag in the webpath leaded by a v, as follows:
- https://italia.github.io/eudi-wallet-it-docs/v0.8.2/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.8.1/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.8.0/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.7.1/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.7.0/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.6.0/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.5.0/en/
- https://italia.github.io/eudi-wallet-it-docs/v0.4.1/en/
This repository is structured to be compliant with
Docs Italia.
This is why the content of the relevant folders will be compiled and rendered inside such platform.
Docs Italia
is designed to support documents, localized in different languages and for this
reason it is the reference platform for displaying this standard.
HTML
pip install -r requirements.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 eidas-it-wallet-docs.odt index.html
This project participates in the versioning model Semantic Versioning.
Furthermore, this project uses the git branches and tags in the following way:
- the branch
versione-corrente
contains the last stable version of the standard; - The release page of GitHub contains all the released versions of the standard. 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. See the preview section for more.
Don't hesitate to submit Pull Requests or raise Issues if you encounter any problems.
The project is covered by a CC-0 license.