From 089bccd7eeae67403ceee87a51e37204c649bc6e Mon Sep 17 00:00:00 2001 From: Jay Gambetta Date: Mon, 4 Feb 2019 03:28:39 -0500 Subject: [PATCH] Update CONTRIBUTING.rst (#1752) --- .github/CONTRIBUTING.rst | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 2f87237ea1..cf6375a491 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -281,22 +281,13 @@ All platforms: Documentation ------------- -The documentation Qiskit Terra is in the ``doc`` directory. The -documentation is auto-generated from python -docstrings using `Sphinx `_ for generating the -documentation. Please follow `Google's Python Style +The documentation for Qiskit Terra is in the ``docs`` directory of `Qiskit repository `_. See this repository for more information, however, the reference +documentation is auto-generated from the python +docstrings throughout the code using `Sphinx `_. Please follow `Google's Python Style Guide `_ for docstrings. A good example of the style can also be found with `sphinx's napolean converter documentation `_. -You can see the rendered documentation for the stable version of Qiskit Terra at -the `landing page `_. - -All platforms: - -.. code:: sh - - $> make doc Development cycle