Skip to content

italia/spid-cie-oidc-docs

Repository files navigation

SPID/CIE OpenID Connect technical specifications

GitHub release Join the #spid openid Get invited Docs Italia Documentation


Table of Contents

Intro

This repository is mantained by the Department for Digital Transformation, the Agency for Digital Italy (AgID), Polygraphic Institute and the State Mint (Istituto Poligrafico e Zecca dello Stato) and hosts the sphinx project tree of SPID/CIE OpenID Connect technical specifications, published to Docs Italia and Github pages.

Documentation

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.

Build

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

Versioning

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 branch dev 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.

How to contribute

Feel free to open Pull Requests and to present a problem with an Issue.

Authors

The publiccode.yml specifications are developed by the Team per la Trasformazione Digitale and by the Authors.

License

The project is covered by a CC-0 license.