You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,6 +151,10 @@ make html
151
151
```
152
152
The above commands build html documentation, they are used to automatically generate [https://docs.monai.io](https://docs.monai.io).
153
153
154
+
The Python code docstring are written in
155
+
[reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) and
156
+
the documentation pages can be in either [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) or [Markdown](https://en.wikipedia.org/wiki/Markdown). In general the Python docstrings follow the [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
157
+
154
158
Before submitting a pull request, it is recommended to:
155
159
- edit the relevant `.rst` files in [`docs/source`](./docs/source) accordingly.
0 commit comments