This repository hosts the sphinx project tree of CIE id SDK Mobile Implementation Guide for the authentication scheme "Entra con CIE".
The current version is published at this link.
Preview of other branches can be navigated by adding the branch name in the webpath, as follows:
- https://italia.github.io/cie-eid-sdk-docs/<branch_name>/it/
Released versions can be navigated by adding the tag in the webpath leaded by a v, as follows:
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/it/doctrees docs/it/ html/it
ODT
sudo apt install pandoc
sphinx-build -b singlehtml docs/it/ html/
cd html
pandoc -o cie-eid-sdk-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-correntecontains 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.
Please help development by reporting problems, suggesting changes and asking questions. To do this, you can create a GitHub Issue for this project in the GitHub Issues for publiccode.yml.
Feel free to open Pull Requests and to present a problem with an Issue.
If you never used GitHub, get up to speed with Understanding the GitHub Flow or follow one of the great free interactive courses in the GitHub learning lab on working with GitHub and working with MarkDown, the syntax this project's documentation is in.
This project is licenced CC-0, which essentially means that the project, along with your contributions is in the Public Domain in whatever jusrisdiction possible, and everyone can do whatever they want with it.
The project is covered by a CC-0 license.