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

Catch absolute paths in our docs/code #41

Open
idomic opened this issue Apr 27, 2023 · 1 comment
Open

Catch absolute paths in our docs/code #41

idomic opened this issue Apr 27, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@idomic
Copy link
Contributor

idomic commented Apr 27, 2023

Reference.

We should add a check to the CI scripts action - it should check absolute paths and fail if it does (can filter on the base URL).

@edublancas
Copy link
Collaborator

so for example, if we're on jupysql's repo, we can add base_url = jupysql.ploomber.io to the pyproject.toml, then fail a check if we detect any links that start with the base URL, since those should be relative.

@edublancas edublancas added good first issue Good for newcomers documentation Improvements or additions to documentation labels May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants