Skip to content

Commit

Permalink
Issue #503 docs: avoid bad rst with openeo_processon undocumented f…
Browse files Browse the repository at this point in the history
…unctions

make sure there are enough empty lines between `seealso` and `rtype` from `sphinx_autodoc_typehints` plugin
  • Loading branch information
soxofaan committed Jul 15, 2024
1 parent ba433de commit fede931
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions openeo/internal/documentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ def openeo_process(f: Optional[T] = None, process_id: Optional[str] = None, mode

process_id = process_id or f.__name__
url = f"https://processes.openeo.org/#{process_id}"
seealso = f'.. seealso:: openeo.org documentation on `process "{process_id}" <{url}>`_.'
f.__doc__ = textwrap.dedent(f.__doc__ or "") + "\n\n" + seealso
seealso = f'.. seealso::\n openeo.org documentation on `process "{process_id}" <{url}>`_.\n'
f.__doc__ = textwrap.dedent(f.__doc__ or "") + "\n\n" + seealso + "\n\n"

_process_registry[process_id].append((f, mode))
return f
Expand Down

0 comments on commit fede931

Please sign in to comment.