Link on Synapse Python Client Documentation points back at itself

Description

I was looking at the Synapse Python Client Documentation page (https://python-docs.synapse.org/build/html/index.html). The last line in the Overview section says "If you're just getting started with Synapse, have a look at the Getting Started guides for Synapse and the Python client." When I click on the link for "the Python client", it just reloads the Synapse Python Client Documentation page.

Environment

Synapse Python Client 1.9.2 documentation web page.

Activity

Show:
Ziming Dong
March 20, 2020, 2:42 AM


You would probably have to build the sphinx docs locally after checking out the 2.0.0-rc branch

and open up _build/html/index.html

I don't think we currently have a staging documentation page

Thomas Yu
March 20, 2020, 3:11 AM
Edited

,

I built this locally and did not see the fix. Can you confirm by building as well?

Couple issues,

  • I still see the link that links back to itself

  • The top says Synapse Python Client 1.9.3 documentation

https://github.com/Sage-Bionetworks/synapsePythonClient/blob/v2.0.0-rc/synapseclient/__init__.py#L22

Ziming Dong
March 20, 2020, 3:19 AM

Looks like the previous pull request only touched the built html, not the python doc-string from which it is generated. Fixing it right now.

Ziming Dong
March 20, 2020, 3:28 AM
Ziming Dong
March 20, 2020, 3:32 AM

Thomas approved the change. I self-merged since there's only a deletion of a link in a doc string.

Assignee

Ziming Dong

Reporter

Cindy Molitor

Labels

Validator

Thomas Yu

Development Area

None

Release Version History

None

Components

Sprint

None

Fix versions

Affects versions

Priority

Minor
Configure