diff options
| author | Edoardo Pasca <edo.paskino@gmail.com> | 2020-01-15 16:38:47 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-15 16:38:47 +0000 |
| commit | effae8056a541b8928caba54f696935c0c5cd014 (patch) | |
| tree | 36f632f111edd556cd7d9c5391caeb19781c1b1e | |
| parent | 26dcd132486c8ab6bb2df4b24d8c053e0b42269c (diff) | |
| download | framework-effae8056a541b8928caba54f696935c0c5cd014.tar.gz framework-effae8056a541b8928caba54f696935c0c5cd014.tar.bz2 framework-effae8056a541b8928caba54f696935c0c5cd014.tar.xz framework-effae8056a541b8928caba54f696935c0c5cd014.zip | |
added developer guide (#485)
closes #460
| -rw-r--r-- | docs/source/developer_guide.rst | 4 | ||||
| -rwxr-xr-x | docs/source/index.rst | 1 |
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/source/developer_guide.rst b/docs/source/developer_guide.rst new file mode 100644 index 0000000..a5e91e0 --- /dev/null +++ b/docs/source/developer_guide.rst @@ -0,0 +1,4 @@ +Developer's guide +################# + +When contributing your code please refer to `this https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format`_ link for docstring formatting.
\ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 266a03a..e129c3a 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -36,6 +36,7 @@ A number of demos can be found on the `CIL-Demos`_ repository. plugins
astra
contrib
+ developer_guide
.. Indices and tables
.. ==================
|