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

Don't parse notebook file #21

Open
hadim opened this issue Oct 28, 2020 · 2 comments
Open

Don't parse notebook file #21

hadim opened this issue Oct 28, 2020 · 2 comments
Labels
fund Issue priority can be boosted

Comments

@hadim
Copy link

hadim commented Oct 28, 2020

I am using the latest version.

I use the mkdocs-jupyter plugin so I have some ipynb files in my nav:

nav:
  - Examples:
      - dsdasda: examples/xxx.ipynb
      - dsdsd: examples/xxx.ipynb
      - dasdasd: examples/xxx.ipynb

It looks like mkdostrings try to parse those files because I have plenty of the following warnings:

WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[O]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[readonly]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[readonly]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[readonly]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[O]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[=C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[=C]' 
WARNING -  mkdocstrings.plugin: examples/dsdsdsd.ipynb: Could not find cross-reference target '[=C]' 

Would that be possible to add an option to ignore those files? (it also slows down the doc building process because usually, those notebook files are quite large (JSON based).

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy
Copy link
Member

pawamoy commented Nov 4, 2020

Damn, sure, we should definitely add a way to ignore some files.

I think I'd like options to ignore both patterns in files, and pattersn in files names.

@pawamoy
Copy link
Member

pawamoy commented May 11, 2023

Moving this to autorefs as it's responsible for cross-references.

@pawamoy pawamoy transferred this issue from mkdocstrings/mkdocstrings May 11, 2023
@pawamoy pawamoy added the fund Issue priority can be boosted label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fund Issue priority can be boosted
Projects
None yet
Development

No branches or pull requests

2 participants