Conio SDK Documentation

Table of Contents

• About the Project
• Prerequisites
• Build and test
• Deploy
• Notes
• Contacts

About The Project

This is the official Conio SDK documentation repository for both platforms Android and iOS.

The whole documentation is written in Markdown and the documentation site is generated through MkDocs.

In order to correctly maintain and update the documentation, you need to install and setup MkDocs.

Prerequisites

1. Create a new Virtual Enviroment (venv) for this project

   python3 -m venv .venv

2. Activate the venv

   . .venv/bin/activate

3. Install the dependencies:

   # IMPORTANT: venv must be active
   pip3 install -r requirements.txt

Please refer to official MkDocs documentation to update and/or modify generated site settings/layout and to MkDocs Material theme to customize theme.

Build and test

MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. Simply run mkdocs serve¹ from root folder and go here.

The dev-server also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file, documentation directory, or theme directory changes.

If you add new *.md files, you will need to execute mkdocs build¹ in order to generate new pages, check here for more info.

PDF Generation

To export the documentation in PDF, follow these steps:

1. Run PDF_EXPORT=true mkdocs serve

2. Open to the unified docs url in your browser.

3. Print the webpage in PDF (using your browser print feature, usually accessible with Ctrl + P / Cmd + P)

Deploy

Once docs are updated and pushed to repository, you will need to deploy the new site with mkdocs gh-deploy --force¹ command.

Check your changes visiting https://sdk-docs.conio.com/

Notes

¹ Be sure the venv is activated

Contacts

• Alessandro Farina - alessandro.farina@conio.com
• Beatrice Buran - beatrice.buran@conio.com
• Giovanni Di Donato - giovanni@conio.com