Skip to content

Documentation

Marc-Olivier Buob edited this page Oct 4, 2021 · 3 revisions

Introduction

The PyBGL has been documented to be compliant with Sphinx using the Google style.

Installation

  • Debian / Ubuntu
sudo apt update
sudo apt install python3-sphinx make

Usage

cd ~/git/PyBGL/doc
make

Once the documentation is generated open ~/git/PyBGL/doc/build/html/index.html with your browser.

Clone this wiki locally