diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c4a53d92a9bb3c8839907a88e2f9c47220e3927e..7a399c6ee8ccad7c2c2c64c1e79a407f05e03274 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::