Skip to content

Draft: docs: add basic Python API docs

Stephan Lachnit requested to merge p-python-api-docs into main

This a draft MR to add API documentation to Python. It is automatically generated using autodoc and autogen via sphinxcontrib.apidoc.

It's not pretty yet, but a good point to start. However, there are several issue that need to be addressed before this can be merged:

docstring of constellation.core.fsm.SatelliteFSM.DEAD:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.DEAD:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.DEAD:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.DEAD:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.DEAD:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.DEAD:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.ERROR:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.INIT:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.INIT:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.INIT:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.INIT:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.INIT:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.INIT:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.NEW:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.NEW:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.NEW:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.NEW:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.NEW:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.NEW:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.ORBIT:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.RUN:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.RUN:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.RUN:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.RUN:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.RUN:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.RUN:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.SAFE:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.initial_state:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.initializing:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.initializing:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.initializing:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.initializing:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.initializing:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.initializing:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.interrupting:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.landing:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.landing:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.landing:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.landing:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.landing:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.landing:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.launching:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.launching:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.launching:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.launching:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.launching:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.launching:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.reconfiguring:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.starting:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.starting:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.starting:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.starting:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.starting:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.starting:62: WARNING: undefined label: 'self-transition'
docstring of constellation.core.fsm.SatelliteFSM.stopping:1: WARNING: undefined label: 'statemachine'
docstring of constellation.core.fsm.SatelliteFSM.stopping:18: WARNING: undefined label: 'transition'
docstring of constellation.core.fsm.SatelliteFSM.stopping:21: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.stopping:23: WARNING: undefined label: 'actions'
docstring of constellation.core.fsm.SatelliteFSM.stopping:43: WARNING: undefined label: 'transitionlist'
docstring of constellation.core.fsm.SatelliteFSM.stopping:62: WARNING: undefined label: 'self-transition'

Not quite sure where this comes from, so needs some investigating.

Merge request reports

imprint | privacy | Conditions of Use