search

VisionSystemsInc / terra

Terra - Run your algorithm anywhere on earth
MIT License
0 stars 3 forks source link

sphinx error for AlreadyRunException #95

Open drewgilliam opened 3 years ago

drewgilliam commented 3 years ago

Sphinx is throwing a new error in downstream repos like terra_dsm:

/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.CropAndCalibrate:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.DSMFusion:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.DSMFusion4D:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.FeatureMatching:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.GeocorrectionDirect:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.GraphSolver:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.ImageDatabaseCreation:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.PostProcessing:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.StereoDSMGeneration:: WARNING: py:exc reference target not found: AlreadyRunException
/src/dsm/workflows.py:docstring of dsm.workflows.GenerateDSMWorkflow.TileCreation:: WARNING: py:exc reference target not found: AlreadyRunException

This appears to be coming from the resumable decorator docstring https://github.com/VisionSystemsInc/terra/blob/55b1ce95705be6bc75f3008879e7e6b4f5a8458e/terra/utils/workflow.py#L43-L46

Maybe the following would fix it (calling out the full exception path)?

  Raises
  ------
  terra.utils.workflow.AlreadyRunException
      Thrown when function attempts to run a second time.