Skip to content

Commit d707e52

Browse files
authored
Fix rst formatting in readme (#1729)
* Fix rst formatting in readme * mark content type for readme as rst
1 parent 4d2d9cd commit d707e52

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ be used anywhere a system with many degrees of freedom is controllable
99
by computer.
1010
To learn more about QCoDeS, browse our `homepage <http://qcodes.github.io/Qcodes>`_ .
1111

12-
To get a feeling of qcodes read
12+
To get a feeling of QCoDeS read
1313
`15 minutes to QCoDeS <http://qcodes.github.io/Qcodes/examples/15_minutes_to_QCoDeS.html>`__,
14-
and/or browse the Jupyter notebooks in `docs/examples
14+
and/or browse the Jupyter notebooks in `docs/examples
1515
<https://github.com/QCoDeS/Qcodes/tree/master/docs/examples>`__ .
1616

17-
1817
QCoDeS is compatible with Python 3.6+. It is primarily intended for use
1918
from Jupyter notebooks, but can be used from traditional terminal-based
2019
shells and in stand-alone scripts as well. The features in

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ def readme():
4646
'Copenhagen / Delft / Sydney / Microsoft quantum computing '
4747
'consortium',
4848
long_description=readme(),
49+
long_description_content_type='text/x-rst',
4950
url='https://github.com/QCoDeS/Qcodes',
5051
classifiers=[
5152
'Development Status :: 3 - Alpha',

0 commit comments

Comments
 (0)