Skip to content
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

docs: replace relative URLs in PyPI documentation #2885

Merged
merged 3 commits into from
Oct 3, 2023

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Sep 30, 2023

Currently, all images and relative links in PyPI documentation documentation are broken, as PyPI doesn't support relative URLs:

image

This PR replaces them with GitHub absolute URLs in the PKG-INFO file of the generated source distribution and wheels.

[<picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/deepmodeling/deepmd-kit/raw/master/./doc/_static/logo-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://github.com/deepmodeling/deepmd-kit/raw/master/./doc/_static/logo.svg"><img alt="DeePMD-kit logo" src="https://github.com/deepmodeling/deepmd-kit/raw/master/./doc/_static/logo.svg"></picture>](https://github.com/deepmodeling/deepmd-kit/tree/master/./doc/logo.md)

- [About DeePMD-kit](https://github.com/deepmodeling/deepmd-kit/tree/master/#about-deepmd-kit)

@njzjz njzjz requested a review from wanghan-iapcm September 30, 2023 20:30
@codecov
Copy link

codecov bot commented Sep 30, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (cf61140) 75.46% compared to head (e6a36ec) 75.46%.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #2885   +/-   ##
=======================================
  Coverage   75.46%   75.46%           
=======================================
  Files         244      244           
  Lines       24518    24518           
  Branches     1580     1580           
=======================================
  Hits        18503    18503           
  Misses       5084     5084           
  Partials      931      931           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@njzjz njzjz changed the title replace relative URLs in PyPI documentation docs: replace relative URLs in PyPI documentation Oct 1, 2023
@wanghan-iapcm wanghan-iapcm merged commit ba86a7b into deepmodeling:devel Oct 3, 2023
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.

2 participants