openvino/docs/nbdoc

Jupyter notebooks autodoc

Auto fetching documentations designed for openvino notebooks tutorials. This module is responsible for fetching artifats, in this particular example jupyter tutorial notebooks and converting them to notebook documentation.

Step 0. Prepare venv

To start new venv based on system interpreter

python -m venv ./venv

Linux:

source ./venv/bin/activate

Windows (cmd):

venv/Scripts/activate

Step 1. Download requirements

python -m pip install -r requirements.txt

Step 2. Download personal token from github account

Tutorial how to do it.. By default configuration you should place it on path ../.secret.

Step 3. Configure consts to meet project directions

Consts file contains multiple variables that might differ for different environments.

Step 4. Add classes with methods to makefile or other executed file

Main file contains example usecases of auto generator for notebooks. Informations placed in main should be further used to add it to makefile and possibly fully automate notebook documentation process.

Step 5. Run python file (optional)

If step 4 was skipped use command

python main.py

or use any other command that is responsible for generating documentation