Mkdocs fail for a specific module, crashing the whole build #365
Comments
|
What docstring style do you use? Did you configure mkdocstrings to use it? I see |
|
I use mkdocs-material, and the whole site renders perfectly. I configured mkdocstrings to use the numpy style, and it renders all the API perfectly: Here's my site_name: pdpipe
site_url: https://pdpipe.readthedocs.io/en/latest/
repo_name: pdpipe
repo_url: https://github.com/pdpipe/pdpipe
edit_uri: edit/master/doc
docs_dir: docs
copyright: © Copyright 2022 Shay Palachy | All Rights Reserved.
nav:
- Home:
- index.md
- More on pdpipe: more.md
- Getting Started:
- Installation: starting/install.md
- First Use: starting/first_use.md
- Pipeline Stages: starting/stages.md
- Pipelines: starting/pipelines.md
- Types of Stages: starting/types.md
- Conditions: starting/cond.md
- Column Qualifiers: starting/cq.md
- Wrappers: starting/wrappers.md
- Develop:
- develop/adhoc.md
- develop/custom.md
- Tutorials:
- tutorials/index.md
- Basic Usage: tutorials/basic.md
- API Reference:
- Core: reference/core.md
- Basic Stages: reference/basic.md
- Column Generation: reference/col_generation.md
- Scikit-learn Stages: reference/sklearn.md
- Scikit-learn Integrations: reference/skintegrate.md
- Text Stages: reference/text.md
- NLTK Stages: reference/nltk.md
- Conditions: reference/cond.md
- Column Qualifiers: reference/cq.md
- Wrappers: reference/wrappers.md
theme:
name: material
features:
- navigation.tabs
- navigation.indexes
- navigation.top
# - navigation.instant
- navigation.tracking
- header.autohide
- content.code.annotate
icon:
repo: fontawesome/brands/github
language: en
font:
text: Roboto
code: Roboto Mono
favicon: images/logo.png
logo: 'images/white_logo.png'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: light green
toggle:
icon: material/lightbulb
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
accent: light green
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
plugins:
- search
- git-revision-date
- awesome-pages
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: true
show_category_heading: true
members_order: source
show_if_no_docstring: true
selection:
docstring_style: numpy
filters: ["!^_"]
# for how to adjust the filters selecting which functions get collected, see:
# https://mkdocstrings.github.io/pytkdocs/#configuration
# for code blocks syntax highlighting
markdown_extensions:
- admonition
- footnotes
- codehilite
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
# use icon paths the match the folder structure in the fontawesome repo:
# https://github.com/FortAwesome/Font-Awesome/tree/master/svgs
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/pdpipe/pdpipe
- icon: fontawesome/solid/comments
link: https://github.com/pdpipe/pdpipe/discussions
- icon: fontawesome/brands/gitter
link: https://gitter.im/pdpipe/community
- icon: fontawesome/brands/python
link: https://pypi.org/project/pdpipe/
- icon: fontawesome/brands/twitter
link: https://twitter.com/shaypal5
extra_css:
- "mkdocs/css/termynal.css"
- "mkdocs/css/custom.css"
- "mkdocs/css/extra.css"
- "mkdocs/css/admonitions.css"
extra_javascript:
- "mkdocs/js/termynal.js"
- "mkdocs/js/custom.js"
- "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML" |
|
But the |
|
Indeed! Too many Thanks for the awesome and speedy reply! <3 <3 |
|
Great 🥳 |
Describe the bug
Mkdocs fails for a specific module, crashing the whole build (see full stacktrace below).
The
skintegrate.mdfile in question is very simple:# Scikit-learn Integrations ::: pdpipe.skintegrateI have nine (!) other identically-structured markdown files residing in the same directory, with the same exact syntax (a header, one blank line, one
mkdocstringscommand pointing at a module of my package. That's it) just pointing to different modules. Also, all are referenced in the same way in themkdocs.yml.If I comment out the
mkdocstringline the page renders:See the resulting page: https://pdpipe.readthedocs.io/en/latest/reference/skintegrate/
It's also not a collection issue, because if I mess with the module name (to get a non-existent module, say
skintegr) I get a different error (so this NOT the stacktrace of my error; continue downwards to find it):Expected behavior
A clear and concise description of what you expected to happen.
Full Stacktrace
Information (please complete the following information):
mkdocstringsversion: mkdocstrings-0.17.0The text was updated successfully, but these errors were encountered: