mkdocstrings / autorefs

Automatically link across pages in MkDocs.
https://mkdocstrings.github.io/autorefs/
ISC License
51 stars 8 forks source link

Don't parse notebook file #21

Open hadim opened 4 years ago

hadim commented 4 years ago

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

Fund with Polar

pawamoy commented 4 years ago

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 commented 1 year ago

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