Skip to content

docs: fix relative links in tutorial #4226

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

Merged
merged 1 commit into from
Aug 1, 2022

Conversation

anjakefala
Copy link
Contributor

mkdocs-jupyter cannot find relative links in upper directories with the
standard markdown syntax
(danielfrg/mkdocs-jupyter#27). Switching to using relative hyperlinking with <a>.

Closes #4064, closes #4201

I tried to test using mike versioning in my local build, but had a hard time figuring out how to add my docs-relative branch to it. I tested with the basic mkdocs serve to make sure it was at least functional there.

mike advice is welcome. Otherwise this has a decent chance of succeeding, and I feel worth trying out with the dev docs.

@codecov
Copy link

codecov bot commented Jul 12, 2022

Codecov Report

Merging #4226 (ead6792) into master (deefd00) will decrease coverage by 57.28%.
The diff coverage is n/a.

❗ Current head ead6792 differs from pull request most recent head 569a285. Consider uploading reports for the commit 569a285 to get more accurate results

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #4226       +/-   ##
===========================================
- Coverage   92.58%   35.29%   -57.29%     
===========================================
  Files         179      158       -21     
  Lines       20218    18346     -1872     
  Branches     2890     2670      -220     
===========================================
- Hits        18718     6476    -12242     
- Misses       1135    11652    +10517     
+ Partials      365      218      -147     
Impacted Files Coverage Δ
ibis/backends/pandas/udf.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/dask/dispatch.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/impala/compat.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/mysql/compiler.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/impala/compiler.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/sqlite/compiler.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/dask/execution/join.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/clickhouse/datatypes.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/datafusion/datatypes.py 0.00% <0.00%> (-100.00%) ⬇️
ibis/backends/dask/execution/window.py 0.00% <0.00%> (-100.00%) ⬇️
... and 156 more

@anjakefala anjakefala marked this pull request as ready for review July 12, 2022 22:22
@cpcloud cpcloud added ddl Issues related to creating or altering data definitions docs Documentation related issues or PRs and removed ddl Issues related to creating or altering data definitions labels Jul 23, 2022
@cpcloud cpcloud modified the milestones: 4.0.0, 3.2.0 Jul 23, 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 cpcloud removed the ddl Issues related to creating or altering data definitions label Aug 1, 2022
Copy link
Member

@cpcloud cpcloud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works locally, let's see how it goes on dev!

@cpcloud cpcloud merged commit 2bd075f into ibis-project:master Aug 1, 2022
@cpcloud
Copy link
Member

cpcloud commented Aug 1, 2022

Looks like it's working nicely! https://ibis-project.org/docs/dev/tutorial/01-Introduction-to-Ibis/

@anjakefala anjakefala deleted the docs-relative branch August 1, 2022 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix broken link in "Introduction to Ibis" tutorial Docs versioning tool is not building working relative links for ibis-project.org
2 participants