search

alphaville / optimization-engine

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

Sphinx-proof docstrings #308

Closed alphaville closed 1 year ago

alphaville commented 1 year ago

Describe the bug 🐞

Make docstrings sphinx-compliant (including LaTeX). Currently, make html gives the following warning:

/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/build_config.py:docstring of opengen.config.build_config.BuildConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/meta.py:docstring of opengen.config.meta.OptimizerMeta:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/solver_config.py:docstring of opengen.config.solver_config.SolverConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/config/solver_config.py:docstring of opengen.config.solver_config.SolverConfiguration:1: WARNING: Field list ends without a blank line; unexpected unindent.
/Users/3054363/Documents/Development/OpEn/open-codegen/venv/lib/python3.8/site-packages/opengen/constraints/simplex.py:docstring of opengen.constraints.simplex.Simplex:1: WARNING: Field list ends without a blank line; unexpected unindent.

To Reproduce 🛠️ 

cd sphinx-dox
make clean
make html