Skip to content

Don't parse notebook file #21

@hadim

Description

@hadim

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions