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

Warnings in webdoc, because of relative links #95

Closed
fralau opened this issue Feb 24, 2024 · 4 comments
Closed

Warnings in webdoc, because of relative links #95

fralau opened this issue Feb 24, 2024 · 4 comments
Labels
bug Something isn't working fixed The issue is fixed please test Fix was pushed and should be tested stale No news, closing

Comments

@fralau
Copy link
Owner

fralau commented Feb 24, 2024

When compiling the MkDocs documentation of the project, warnings appear (this is a new thing):

INFO    -  Building documentation...
INFO    -  MERMAID2  - Initialization arguments: {}
INFO    -  MERMAID2  - Using javascript library (10.1.0):
              https://unpkg.com/[email protected]/dist/mermaid.esm.min.mjs
INFO    -  Cleaning site directory
INFO    -  Doc file 'index.md' contains an unrecognized relative link
           '../library', it was left as is.
INFO    -  Doc file 'index.md' contains an unrecognized relative link
           'superfences/#usage-for-the-material-theme', it was left as is. Did you
           mean 'superfences.md#usage-for-the-material-theme'?
INFO    -  Doc file 'contribute.md' contains an unrecognized relative link
           '../troubleshooting', it was left as is. Did you mean
           'troubleshooting.md'?
INFO    -  Doc file 'description.md' contains an unrecognized relative link
           'superfences', it was left as is. Did you mean 'superfences.md'?
INFO    -  Doc file 'library.md' contains an unrecognized relative link
           '../description/#insertion-of-the-javascript-library', it was left as
           is. Did you mean 'description.md#insertion-of-the-javascript-library'?
INFO    -  Doc file 'library.md' contains an unrecognized relative link
           '../description/#automatic-insertion-of-the-javascript-library', it was
           left as is. Did you mean
           'description.md#automatic-insertion-of-the-javascript-library'?
INFO    -  Doc file 'library.md' contains an unrecognized relative link
           '../description/#initialization-sequence', it was left as is. Did you
           mean 'description.md#initialization-sequence'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           'superfences#specifying-the-mermaid-custom-fence', it was left as is.
           Did you mean 'superfences.md#specifying-the-mermaid-custom-fence'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../#specifying-the-version-of-the-mermaid-library', it was left as is.
           Did you mean 'index.md#specifying-the-version-of-the-mermaid-library'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../#other-themes', it was left as is. Did you mean
           'index.md#other-themes'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../library', it was left as is. Did you mean 'library.md'?
INFO    -  Doc file 'troubleshooting.md' contains an absolute link
           '/#specifying-the-version-of-the-mermaid-library', it was left as is.
           Did you mean 'index.md#specifying-the-version-of-the-mermaid-library'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../library', it was left as is. Did you mean 'library.md'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../superfences/#usage-for-the-material-theme', it was left as is. Did
           you mean 'superfences.md#usage-for-the-material-theme'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../tips/#setting-the-security-level-to-loose', it was left as is. Did
           you mean 'tips.md#setting-the-security-level-to-loose'?
INFO    -  Doc file 'troubleshooting.md' contains an unrecognized relative link
           '../#specifying-the-version-of-the-mermaid-library', it was left as is.
           Did you mean 'index.md#specifying-the-version-of-the-mermaid-library'?
INFO    -  MERMAID2  - Found superfences config: {'custom_fences': [{'name':
           'mermaid', 'class': 'mermaid', 'format': functools.partial(<function
           fence_mermaid at 0x101df9360>, custom=True)}]}
INFO    -  MERMAID2  - Found 'fence_mermaid_custom' function: activate custom
           loader for superfences

These relative links should be fixed.

@fralau fralau changed the title Warnings because of relative links Warnings in webdoc, because of relative links Feb 24, 2024
@fralau fralau added bug Something isn't working help wanted Extra attention is needed labels Feb 24, 2024
@fralau fralau added fixed The issue is fixed please test Fix was pushed and should be tested and removed help wanted Extra attention is needed labels Feb 25, 2024
@fccagou
Copy link

fccagou commented Feb 25, 2024

What is the time before readthedoc.io update ?

@fralau
Copy link
Owner Author

fralau commented Feb 25, 2024

Normally the push should have triggered it.

@fccagou
Copy link

fccagou commented Feb 25, 2024

Still not good for me.

fralau pushed a commit that referenced this issue Mar 6, 2024
  - the `build` section was missing in `.readthedocs.yml`
@fralau
Copy link
Owner Author

fralau commented Mar 6, 2024

@fccagou Problem with ReadTheDocs solved.

Could you please check?

@fralau fralau added the stale No news, closing label Apr 4, 2024
@fralau fralau closed this as completed Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fixed The issue is fixed please test Fix was pushed and should be tested stale No news, closing
Projects
None yet
Development

No branches or pull requests

2 participants