6761a29af5
* update-notebooks * Update docs/nbdoc/nbdoc.py Co-authored-by: bstankix <bartoszx.stankiewicz@intel.com> * Update docs/nbdoc/nbdoc.py Co-authored-by: bstankix <bartoszx.stankiewicz@intel.com> --------- Co-authored-by: bstankix <bartoszx.stankiewicz@intel.com>
Jupyter notebooks autodoc
Auto fetching documentations designed for openvino notebooks tutorials. This module is responsible for fetching artifacts, 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. Configure consts to meet project directions
Consts file contains multiple variables that might differ for different environments.
Step 3. 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 4. 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