Skip to content

MNT: fixed documentation links in the readme#1310

Merged
larsoner merged 3 commits intosphinx-gallery:masterfrom
story645:patch-1
May 20, 2024
Merged

MNT: fixed documentation links in the readme#1310
larsoner merged 3 commits intosphinx-gallery:masterfrom
story645:patch-1

Conversation

@story645
Copy link
Copy Markdown
Contributor

I'm getting the following 404 with the current links in the readme:
image

story645 added 2 commits May 20, 2024 12:20
I'm getting the following 404 with the current links in the readme:
pypi was complaining about a double reference, so I pulled the url out into a target link. Upside is that now only one place to update if the url changes.
@larsoner
Copy link
Copy Markdown
Contributor

Unfortunately the deduplication causes problems because we use .. <whatever>-begin-content type comments to take parts of the README.rst and use them in doc/index.rst, it's causing the real/related CircleCI failure:

https://app.circleci.com/pipelines/github/sphinx-gallery/sphinx-gallery/2442/workflows/c6a170e2-307b-4dc3-ba36-79c812404765/jobs/5057

README.rst:3: ERROR: Unknown target name: "documentation".

I think if you move the new link inside the .. citation-begin-content block it should fix things. I'll try pushing that

@larsoner larsoner enabled auto-merge (squash) May 20, 2024 19:01
@larsoner larsoner merged commit 049ae4d into sphinx-gallery:master May 20, 2024
@larsoner
Copy link
Copy Markdown
Contributor

Thanks @story645 !

@story645 story645 deleted the patch-1 branch May 20, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants