From effae8056a541b8928caba54f696935c0c5cd014 Mon Sep 17 00:00:00 2001 From: Edoardo Pasca Date: Wed, 15 Jan 2020 16:38:47 +0000 Subject: added developer guide (#485) closes #460 --- docs/source/developer_guide.rst | 4 ++++ docs/source/index.rst | 1 + 2 files changed, 5 insertions(+) create mode 100644 docs/source/developer_guide.rst (limited to 'docs') 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 .. ================== -- cgit v1.2.3