/freecad-python-stubs

FreeCAD C++/Python bindings

Primary LanguagePython

FreeCAD python stubs

This meant to contain all the FreeCAD C++ to Python bindings, types for the Document Object property system and Scripted Object Python types.

Structure

  • stubs/ - *.pyi files for FreeCAD C++ defined Python modules and packages
  • docker/ - scripts to develop sphinx documentation locally

Generate sphinx documentation

# rename workaround, see https://github.com/readthedocs/sphinx-autoapi/issues/243
./rename.sh
# generate html
./docker/run.sh make clean html

Pipeline vision

Here's how python stub files are intended to be generated and used:

We're not there yet though.

See also