Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

DOC: Add InnerEye/Common docstrings to RTD #797

Merged
merged 30 commits into from
Sep 13, 2022
Merged

DOC: Add InnerEye/Common docstrings to RTD #797

merged 30 commits into from
Sep 13, 2022

Conversation

peterhessey
Copy link
Contributor

Closes #785

@peterhessey
📝 Create basic for ML API
267d4e8
@peterhessey
📝 Add ML/configs base doc files
806f261
@peterhessey
📝 Finish ML/configs API
0cbd7c7
@peterhessey
📝 Update augmentations
f5c82cf
@peterhessey
📝 Add ML/dataset API docs
ac0171a
@peterhessey
📝 Add rst skeleton for ML/models
e9fff6a
@peterhessey
📝 Fix docstring missing newlines
4fd8de4
@peterhessey
Remove script
6371548
@peterhessey
📝 Finish ML/models API docs
27e7784
@peterhessey
📝 Start ML/SSL API. Fix some formatting issues
6a1273f
@peterhessey
📝 Correct whitespace issues in :param
562173b
@peterhessey
📝 Fix whitespace errors on :return statements
416e907
@peterhessey
📝 Fix :return: statements
a778dac
@peterhessey
📝 Finish ML/SSL API
33b557c
@peterhessey
📝 Add ML/utils API docs
7d4f466
@peterhessey
📝 Add visualizer docs, fix :raise indents
19ab5b2
@peterhessey
📝 Fix more issues with the :raises: formatting
67169af
@peterhessey
♻️ Restructuring folders
7619004
@peterhessey
📝 Limit API toctree depth
bdc2a51
@peterhessey
📝 Add primary InnerEye/ML files API to docs
56c3a52
@peterhessey
📝 Fix and add InnerEye/ML/*.py docs
e9e5ee8
@peterhessey
⚰️ Remove weird settings.json change
c1d84a8
@peterhessey
📌 Switch recommonmark to MyST-parser
933bc7b
@peterhessey
📌 Add myst-parser to environment.yml, lock env
6e610b0
@peterhessey
Fix conflicts merging main
a9a5278
@peterhessey
🚧 Add Common docs
e4e86df
@peterhessey
📝 Add common docstrings fixes
58535d3
@peterhessey
Merge branch 'main' into phessey/add-common-docstrings-to-RTD
ce4a4f4
@peterhessey
🐛 Remove git artifacts
d3c618d
@peterhessey
Merge branch 'main' into phessey/add-common-docstrings-to-RTD
ce1c05e
@peterhessey peterhessey marked this pull request as ready for review September 12, 2022 11:39
@peterhessey peterhessey merged commit 5748968 into main Sep 13, 2022
@peterhessey peterhessey deleted the phessey/add-common-docstrings-to-RTD branch September 13, 2022 12:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kenza-bouzid kenza-bouzid kenza-bouzid approved these changes

@ant0nsc ant0nsc ant0nsc approved these changes

@javier-alvarez javier-alvarez Awaiting requested review from javier-alvarez

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add InnerEye/Common docstrings to ReadTheDocs
3 participants
@peterhessey @ant0nsc @kenza-bouzid