Skip to content

README.rst is not rendered correctly on GitHub #634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
twrasmussen opened this issue Jan 22, 2024 · 3 comments · Fixed by #639
Closed

README.rst is not rendered correctly on GitHub #634

twrasmussen opened this issue Jan 22, 2024 · 3 comments · Fixed by #639
Assignees
Labels
bug Something isn't working
Milestone

Comments

@twrasmussen
Copy link

Specifications

  • Client Version:
  • InfluxDB Version:
  • Platform:

Code sample to reproduce problem

Expected behavior

Links to v1 client library in readme no longer linked to valid web page

Actual behavior

Links to v1 client library in readme no longer linked to valid web page

Additional info

Links to v1 client library in readme no longer linked to valid web page

@twrasmussen twrasmussen added the bug Something isn't working label Jan 22, 2024
@powersj
Copy link
Contributor

powersj commented Jan 22, 2024

It seems like GitHub is not rendering the RST formatted README correctly currently: https://github.com/influxdata/influxdb-client-python

The URL itself is correct, it is that the rendering is incorrect. This is what shows up due to the rendering looking strange:

https://github.com/influxdata/influxdb-python%3E%60_

Given there have been no updates to the README in 6 months, I am thinking this is a GitHub issue or they have changed something

@bednar
Copy link
Contributor

bednar commented Jan 23, 2024

The "rst" format is still supported, as seen here: sphinx-readme README.rst. Therefore, we need to review the syntax of our README.rst to ensure it's correct.

@bednar bednar changed the title Readme v1 client library links broken README.rst is not rendered correctly on GitHub Jan 24, 2024
@bednar
Copy link
Contributor

bednar commented Jan 26, 2024

The GitHub uses this project to convert RST to HTML - https://github.com/github/markup

@bednar bednar self-assigned this Jan 26, 2024
@bednar bednar added this to the 1.41.0 milestone Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants