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: Fix broken links / cleanup README #1395

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

felinira
Copy link
Contributor

Fix broken links so that cargo doc is happy.

Uses a trick with redefining the markdown link anchors to make the links in the README.md work both in github and generated docs (the former linking to gtk-rs.org, the latter linking to the generated docs). Not sure if this is worth the effort but I stumbled upon this trick on the internet and found the solution to be quite neat.

@felinira
Copy link
Contributor Author

btw, what's up with the docs embed CI failure?

glib/README.md Outdated Show resolved Hide resolved
glib/src/lib.rs Outdated Show resolved Hide resolved
@bilelmoussaoui
Copy link
Member

do you mind rebasing this PR to see if the docs embed still complains about the safety doc ?

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.

None yet

2 participants