From 05857385e2e3c2c0416e0659ebc19c0661d69e4e Mon Sep 17 00:00:00 2001 From: Robert Habermann <mail@rhab.de> Date: Sat, 30 Apr 2016 22:00:23 +0200 Subject: [PATCH] fix layout --- CONTRIBUTING.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c4a53d9..7a399c6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -51,13 +51,15 @@ Writing Documentation Google Docstring format for:: -- Args: (includes \*\*kwargs) +- Args: (includes **kwargs) - Returns: - Raises: - Examples: -https://sphinxcontrib-napoleon.readthedocs.org/en/latest/ -https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google +Sphinx Napoleon Docs:: + + https://sphinxcontrib-napoleon.readthedocs.org/en/latest/ + https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google To including private method in the automatically generate Sphinx documentation add:: -- GitLab