You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
EDIT: I figured out the native autorefs as soon as I sent this. Please disregard!
My docstrings are currently Sphinx formatted, but obviously there will need to be cleanup there to make anything Markdown-related work. I already have a huge Markdown cleanup utility going because the initial rST-to-Markdown conversion resulted in a lot of things that aren't going to work with my potential Markdown config, plugins, etc, as well as needing to convert our existing translations to Markdown. So, adding in cleaning up the docstrings should be pretty straightforward. However, I need to figure out what I'm converting to.
I may be missing something obvious here, so I'll first ask: can I use the objects.inv generated bymkdocstringsinmkdocstrings? To provide the equivalent of intersphinx-mapping to my own content.
If not, then that answers this question.
That said, if not, is there a way to do this for mkdocstrings that I'm missing? I've sorted out a way to do it in the documentation general content using a generated file- and class-location index included under the extra key in the mkdocs.yml file with Jinja macros and the Macros plugin. But I'm not sure if it would even work with mkdocstrings (it would depend on load order), and also I'm not sure my project lead will approve of having odd Jinja syntax in docstrings (though he's ok with it in the docs, so maybe?). Anyway, point is, if there's some native way to do this, I'd love to hear about it.
If it is possible to use the generated objects.inv file, then the issue I'm experiencing is that it's not loading, and returns the following error:
ERROR - mkdocstrings: Couldn't load inventory https://github.com/kattni/beeware/blob/tooling/mkdocs/docs/objects.inv through handler 'python': Error -3 while decompressing data: incorrect header check
I've looked through the docs and the issues/discussions here, and I see no mention of this error. Research indicates it's actually a zlib error, but I tried generating a .inv file using another tool, and it failed the same way.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hello!
EDIT: I figured out the native autorefs as soon as I sent this. Please disregard!
My docstrings are currently Sphinx formatted, but obviously there will need to be cleanup there to make anything Markdown-related work. I already have a huge Markdown cleanup utility going because the initial rST-to-Markdown conversion resulted in a lot of things that aren't going to work with my potential Markdown config, plugins, etc, as well as needing to convert our existing translations to Markdown. So, adding in cleaning up the docstrings should be pretty straightforward. However, I need to figure out what I'm converting to.
I may be missing something obvious here, so I'll first ask: can I use the
objects.inv
generated bymkdocstrings
inmkdocstrings
? To provide the equivalent of intersphinx-mapping to my own content.If not, then that answers this question.
That said, if not, is there a way to do this for
mkdocstrings
that I'm missing? I've sorted out a way to do it in the documentation general content using a generated file- and class-location index included under theextra
key in themkdocs.yml
file with Jinja macros and the Macros plugin. But I'm not sure if it would even work withmkdocstrings
(it would depend on load order), and also I'm not sure my project lead will approve of having odd Jinja syntax in docstrings (though he's ok with it in the docs, so maybe?). Anyway, point is, if there's some native way to do this, I'd love to hear about it.If it is possible to use the generated
objects.inv
file, then the issue I'm experiencing is that it's not loading, and returns the following error:I've looked through the docs and the issues/discussions here, and I see no mention of this error. Research indicates it's actually a
zlib
error, but I tried generating a.inv
file using another tool, and it failed the same way.Any assistance would be appreciated.
Thanks!
Beta Was this translation helpful? Give feedback.
All reactions