scnc
/
qiskit
mirror of https://github.com/Qiskit/qiskit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.rst (#1752)

This commit is contained in:
Jay Gambetta 2019-02-04 03:28:39 -05:00 committed by Juan Gomez
parent e4579c10d6
commit 089bccd7ee
1 changed files with 3 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/CONTRIBUTING.rst vendored
View File

@ -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 <http://www.sphinx-doc.org>`_ for generating the
documentation. Please follow `Google's Python Style
The documentation for Qiskit Terra is in the ``docs`` directory of `Qiskit repository <https://github.com/Qiskit/qiskit/tree/master/docs>`_. See this repository for more information, however, the reference
documentation is auto-generated from the python
docstrings throughout the code using `Sphinx <http://www.sphinx-doc.org>`_. Please follow `Google's Python Style
Guide <https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments>`_
for docstrings. A good example of the style can also be found with
`sphinx's napolean converter
documentation <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_.
You can see the rendered documentation for the stable version of Qiskit Terra at
the `landing page <https://qiskit.org/terra>`_.
All platforms:
.. code:: sh
$> make doc
Development cycle