This repository hosts the sphinx project tree of SPID/CIE OpenID Connect technical specifications, published to Docs Italia.
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 patform.
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
# italian version
sphinx-build -b html -d html/it/doctrees docs/it/ html/it
# english version
sphinx-build -b html -d html/en/doctrees docs/en/ html/en
ODT
sudo apt install pandoc
sphinx-build -b singlehtml docs/it/ html/
cd html
pandoc -o spid-cie-oidc-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
master
contains the last stable version of the standard; - the branch
development
contains the proposed updates to be discussed in the next 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.
Since this repository contains both the core
schema and the schemas with the extensions for each country,
a more refined versioning strategy must be adopted. For this reason, each update of the core and/or the specific country extensions, will be tagged as follows:
core-x.y.z;cc-a.b.c
where cc represents the country code in the key countryExtensionVersion
of the changed schema.
Feel free to open Pull Requests and to present a problem with an Issue.
The publiccode.yml
specifications are developed by the Team per la Trasformazione
Digitale and by the Authors.
The project is covered by a CC-0 license.