Skip to content

Commit 7eb8700

Browse files
authored
Merge pull request #40 from stonerlab/copilot/fix-readme-syntax-errors
Make README long description PyPI-compatible by removing Sphinx-only `:doc:` role
2 parents e6754b5 + 6388149 commit 7eb8700

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ The **Stoner.Zip** module provides a similar set of classes to **Stoner.HDF5** b
172172
Resources
173173
==========
174174

175-
Included in the `github repository`_ are a (small) collection of sample scripts
175+
Included in the `github repository`_ are a (small) collection of sample scripts
176176
for carrying out various operations and some sample data files for testing the loading and processing of data. There is also a
177-
`User_Guide`_ as part of this documentation, along with a :doc:`complete API reference <Stoner>`
177+
`User_Guide`_ as part of this documentation, along with the `complete API reference`_
178178

179179
Contact and Licensing
180180
=====================
@@ -279,3 +279,4 @@ Versions 0.7.x and earlier are now pre-historic!
279279
.. _github repository: http://www.github.com/stonerlab/Stoner-PythonCode/
280280
.. _Dr Gavin Burnell: http://www.stoner.leeds.ac.uk/people/gb
281281
.. _User_Guide: http://stoner-pythoncode.readthedocs.io/en/latest/UserGuide/ugindex.html
282+
.. _complete API reference: http://stoner-pythoncode.readthedocs.io/en/latest/Stoner.html

doc/readme.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,9 +172,9 @@ The **Stoner.Zip** module provides a similar set of classes to **Stoner.HDF5** b
172172
Resources
173173
==========
174174

175-
Included in the `github repository`_ are a (small) collection of sample scripts
175+
Included in the `github repository`_ are a (small) collection of sample scripts
176176
for carrying out various operations and some sample data files for testing the loading and processing of data. There is also a
177-
`User_Guide`_ as part of this documentation, along with a :doc:`complete API reference <Stoner>`
177+
`User_Guide`_ as part of this documentation, along with the `complete API reference`_
178178

179179
Contact and Licensing
180180
=====================
@@ -279,3 +279,4 @@ Versions 0.7.x and earlier are now pre-historic!
279279
.. _github repository: http://www.github.com/stonerlab/Stoner-PythonCode/
280280
.. _Dr Gavin Burnell: http://www.stoner.leeds.ac.uk/people/gb
281281
.. _User_Guide: http://stoner-pythoncode.readthedocs.io/en/latest/UserGuide/ugindex.html
282+
.. _complete API reference: http://stoner-pythoncode.readthedocs.io/en/latest/Stoner.html

0 commit comments

Comments
 (0)