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

Links not rendered correctly in Documentation page on website #361

Closed
giordano opened this issue Apr 25, 2024 · 4 comments · Fixed by #364
Closed

Links not rendered correctly in Documentation page on website #361

giordano opened this issue Apr 25, 2024 · 4 comments · Fixed by #364
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@giordano
Copy link
Member

Which Section of the Documentation Needs Improving?

Some links in https://github-pages.arc.ucl.ac.uk/python-tooling/pages/docs.html#documentation aren't rendered correctly

What Can be Improved About This Section

If you're using GitHub, one option is to host your docs on [GitHub pages].
[Here's how we've set this up][template-docs-dot-yaml] for [our template].
<!-- URL used above in the blurb-->
[docstrings]: https://peps.python.org/pep-0257/#what-is-a-docstring
[GitHub pages]: https://docs.github.com/en/pages
[our template]:
https://github.com/UCL-ARC/python-tooling?tab=readme-ov-file#using-this-template
[template-docs-dot-yaml]:
https://github.com/UCL-ARC/python-tooling/blob/main/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/docs.yml
I believe this was broken by #356.

How to Improve This Section

No response

@giordano giordano added the documentation Improvements or additions to documentation label Apr 25, 2024
@paddyroddy
Copy link
Member

Thanks, looks like prettier/prettier#9232 is why

@paddyroddy
Copy link
Member

Not a problem with the other markdown link format

@paddyroddy
Copy link
Member

And not problem on GitHub, only on the website

@paddyroddy
Copy link
Member

Looks like I can fix it with https://github.com/github/jekyll-commonmark-ghpages, but that has it's downsides so will revert (manually)

paddyroddy added a commit that referenced this issue Apr 25, 2024
@paddyroddy paddyroddy linked a pull request Apr 25, 2024 that will close this issue
@paddyroddy paddyroddy added the bug Something isn't working label Apr 25, 2024
@paddyroddy paddyroddy changed the title Links not rendered correctly in Documentation page Links not rendered correctly in Documentation page on website Apr 25, 2024
paddyroddy added a commit that referenced this issue Apr 25, 2024
These were the only culprits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants