Skip to content

Make README long description PyPI-compatible by removing Sphinx-only :doc: role#40

Merged
gb119 merged 1 commit into
mainfrom
copilot/fix-readme-syntax-errors
May 25, 2026
Merged

Make README long description PyPI-compatible by removing Sphinx-only :doc: role#40
gb119 merged 1 commit into
mainfrom
copilot/fix-readme-syntax-errors

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 25, 2026

PyPI publishing failed during metadata rendering because README.rst used a Sphinx-only :doc: role (Unknown interpreted text role "doc"). This updates README link markup to plain reStructuredText so the long description renders in PyPI while preserving documentation navigation.

  • Problem scope

    • PyPI validates long_description as standard RST, not Sphinx extensions.
    • The failing role appeared in both README.rst and doc/readme.rst.
  • Changes made

    • Replaced :doc:\complete API reference `` with a standard hyperlink reference.
    • Added a new reference target:
      • .. _complete API reference: http://stoner-pythoncode.readthedocs.io/en/latest/Stoner.html
    • Applied the same patch to both README copies to keep docs content aligned.
    • Removed an extra double-space in the touched sentence while editing the line.
  • Resulting markup pattern

Included in the `github repository`_ are a (small) collection of sample scripts
for carrying out various operations and some sample data files for testing the loading and processing of data. There is also a
`User_Guide`_ as part of this documentation, along with the `complete API reference`_

.. _complete API reference: http://stoner-pythoncode.readthedocs.io/en/latest/Stoner.html

@gb119 gb119 marked this pull request as ready for review May 25, 2026 11:07
Copilot AI review requested due to automatic review settings May 25, 2026 11:07
@gb119 gb119 merged commit 7eb8700 into main May 25, 2026
1 check failed
@gb119 gb119 deleted the copilot/fix-readme-syntax-errors branch May 25, 2026 11:07
@gb119 gb119 restored the copilot/fix-readme-syntax-errors branch May 25, 2026 11:09
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes PyPI long-description rendering failures by removing the Sphinx-only :doc: role from the mirrored README files and replacing it with standard reStructuredText hyperlink markup that PyPI can parse.

Changes:

  • Replaced :doc:\complete API reference ` with a standard RST reference link (complete API reference`_).
  • Added a corresponding .. _complete API reference: reference target in both README copies.
  • Normalized spacing in the touched “github repository” sentence.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.rst Replaces Sphinx-only role with plain RST link + adds link target for PyPI-compatible rendering.
doc/readme.rst Mirrors the same RST link change to keep documentation copies aligned.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants