Skip to content

MkDocs builds perfectly locally, but gets stuck on Read the Docs #7865

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

Closed
Octelly opened this issue Jan 24, 2021 · 2 comments
Closed

MkDocs builds perfectly locally, but gets stuck on Read the Docs #7865

Octelly opened this issue Jan 24, 2021 · 2 comments

Comments

@Octelly
Copy link

Octelly commented Jan 24, 2021

Details

Expected Result

Successfully build the docs just like I can do locally with mkdocs build or mkdocs serve

Actual Result

Always gets stuck at

ERROR   -  Config value: 'markdown_extensions'. Error: unsupported callable 

Aborted with 1 Configuration Errors!

I honestly have no clue if this is a bug or if I did something wrong, I at least triple checked everything, so I hope someone more experienced can help me.

@nmichlo
Copy link

nmichlo commented Jan 24, 2021

I had exactly the same issue.

The problem is the emoji markdown plugin:

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

Examining the step just before the error at cat mkdocs.yml. The problem seems to be that readthedocs generates a custom version of the mkdocs.yml file by parsing it, injecting keys and resaving the file.

This process is not able to handle the oddly formatted values for emoji_index and emoji_generator which become null.

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: null
      emoji_generator: null

I have tried quoting these values, which preserves them, but mkdocs itself does then not support the quoted quotations (tested this locally too).

nmichlo added a commit to nmichlo/disent that referenced this issue Jan 24, 2021
Octelly added a commit to Octelly/pluralkit.py that referenced this issue Jan 25, 2021
disabling the emoji feature of pymdownx as recommended here: readthedocs/readthedocs.org#7865 (comment)
@humitos
Copy link
Member

humitos commented Jan 25, 2021

This problem is solved in #7507 and will be deployed tomorrow or the next week.

@stsewd stsewd closed this as completed Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants