dense-visual-odometry

Python implemented Dense Visual Odometry

Generate documentation

This repo uses Numpy docstrings. To generate the documentation locally as HTML pages one can use pydoctor:

python3 -m venv venv
source venv/bin/activate
pip install pydoctor==22.5.1
pydoctor --project-name=dense-visual-odometry --project-version=0.0.1 --project-url=https://github.com/pfontana96/dense-visual-odometry --make-html --html-output=docs --project-base-dir="src/dense_visual_odometry/" --docformat=numpy src/dense_visual_odometry/

which will generate the code documentation under a directory named docs (ommitted on .gitignore)