Api docs

[richardjgowers]

use autosummary to generate API docs skeleton

works out a few sphinx warnings that we were getting

[pep8speaks]

Hello @richardjgowers! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file gufe/custom_json.py:

Line 164:41: W605 invalid escape sequence '\s'

• In the file gufe/protocols/protocoldag.py:

Line 309:80: E501 line too long (82 > 79 characters) Line 314:80: E501 line too long (80 > 79 characters)

• In the file gufe/settings/models.py:

Line 147:1: W293 blank line contains whitespace

• In the file gufe/storage/__init__.py:

Line 1:55: W292 no newline at end of file

• In the file gufe/tokenization.py:

Line 697:80: E501 line too long (83 > 79 characters)

Comment last updated at 2024-01-30 09:42:43 UTC

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (1f77481) 99.22% compared to head (13e8492) 99.22%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #277 +/- ## ======================================= Coverage 99.22% 99.22% ======================================= Files 36 36 Lines 1938 1948 +10 ======================================= + Hits 1923 1933 +10 Misses 15 15 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.