Skip to content

Docs versioning tool is not building working relative links for ibis-project.org #4064

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
anjakefala opened this issue Jun 8, 2022 · 4 comments · Fixed by #4226
Closed
Assignees
Labels
dependencies Issues or PRs related to dependencies docs Documentation related issues or PRs

Comments

@anjakefala
Copy link
Contributor

anjakefala commented Jun 8, 2022

E.g. https://ibis-project.org/backends/SQLite/#install linked to from here: https://ibis-project.org/docs/3.0.2/tutorial/01-Introduction-to-Ibis/.

Source code shown: https://github.com/ibis-project/ibis/pull/4038/files#diff-15dc5f0c70736230279998fc98d3472bfe89bed557277c4e5e5640e41898bbc1L26.

From chatting with @cpcloud, when built locally the links are built appropriately, but it is not working with the docs versioning tool being used to build the website in production.

List of links with the problem:
docs/tutorial/01-Introduction-to-Ibis.ipynb: "To start using Ibis, you need a Python environment with Ibis installed. Follow the installation instructions for SQLite to setup an environment.\n",

https://ibis-project.org/backends/SQLite/#install

docs/tutorial/04-More-Value-Expressions.ipynb: "The Ibis type system supports the most common data types used in analytics, including support for nested types like lists, structs, and maps.\n",

https://ibis-project.org/api/datatypes

@cpcloud
Copy link
Member

cpcloud commented Jun 8, 2022

I think it might be an issue with mkdocs-jupyter, since we do have relative links elsewhere in the documentation that work, e.g., here.

@anjakefala
Copy link
Contributor Author

/take

@anjakefala
Copy link
Contributor Author

anjakefala commented Jun 10, 2022

I can confirm this bug is specifically the result of mkdocs-jupyter behaviour. I am still exploring this, but initial findings hint that this might be tricky to do: danielfrg/mkdocs-jupyter#27

@cpcloud cpcloud added docs Documentation related issues or PRs dependencies Issues or PRs related to dependencies labels Jul 9, 2022
anjakefala added a commit to anjakefala/ibis that referenced this issue Jul 12, 2022
mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

Closes ibis-project#4064, closes ibis-project#4201
anjakefala added a commit to anjakefala/ibis that referenced this issue Jul 12, 2022
mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

Closes ibis-project#4064, closes ibis-project#4201
cpcloud pushed a commit to anjakefala/ibis that referenced this issue Aug 1, 2022
mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

Closes ibis-project#4064, closes ibis-project#4201
cpcloud pushed a commit that referenced this issue Aug 1, 2022
mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

Closes #4064, closes #4201
@anjakefala
Copy link
Contributor Author

anjakefala commented Aug 1, 2022

For folks in the future:

mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

The solution is to use html <a> tag (e.g. Follow the <a href='../../backends/SQLite#install'>installation instructions for SQLite</a> to setup an environment.\n",)

cwisecarver pushed a commit to Parsely/ibis that referenced this issue Aug 1, 2022
mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27).

Closes ibis-project#4064, closes ibis-project#4201
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Issues or PRs related to dependencies docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants