alphaville / optimization-engine

Nonconvex embedded optimization: code generation for fast real-time optimization + ROS support
https://alphaville.github.io/optimization-engine/
Other
499 stars 53 forks source link

Sphinx autodocs deployment #305

Closed alphaville closed 1 year ago

alphaville commented 1 year ago

Main Changes :construction:

New GitHub Action which

Moreover,

To create the documentation locally, do the following:

  1. outside the virtual environment install sphinx (ref) using
    pip install sphinx
    pip install sphinx-rtd-theme
  2. Activate the virtual environment and install opengen (pip install .)
  3. Go to sphinx-dox and run
    sphinx-apidoc -o ./source/ ../open-codegen/opengen ../open-codegen/opengen/test/
    make html

:children_crossing: this job will only run if the commit is on the master branch or if the commit message contains [docit]

Associated Issues :lady_beetle:

Checklist :tractor: