Replies: 2 comments 1 reply
-
We are merging and deploying this PR today/tomorrow: readthedocs/readthedocs.org#11206 that removes the manipulation of the YAML file from Read the Docs. Users should be able to use all the supported YAML syntax on Read the Docs after the deploy 🎉 . Thanks for all your support! |
Beta Was this translation helpful? Give feedback.
1 reply
-
Can this discussion be marked as solved now that people can use all the YAML syntax that MkDocs supports? Thanks. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
MkDocs 1.5 added a custom
!relative
tag. ReadTheDocs currently only handles!!python/name
tags. Support was added in this PR: readthedocs/readthedocs.org#7507. Latest code can be found here:https://github.com/readthedocs/readthedocs.org/blob/main/readthedocs/doc_builder/backends/mkdocs.py. As you can see the safe loader still only handles these tag. I guess it means that
!relative
tag are not supported, and upon re-dumping YAML, these values would simply be lost.ReadTheDocs wants to find a way to better integrate with MkDocs, to avoid having to fake-implement custom tags just to inject configuration. See readthedocs/readthedocs.org#7844. Maybe we could discuss this here as well.
Beta Was this translation helpful? Give feedback.
All reactions