With the implosion of mkdocs, will this library be maintained?

[MaddyGuthridge]

As you may be aware, mkdocs and its surrounding ecosystem is imploding. From what I have gathered, there seems to be a lot of fragmentation, with mkdocstrings now deprecated, and its replacement being tied to zensical, a tool which while promising, is still in alpha.

Given this project is part of the mkdocstrings org on GitHub, the current state of things makes me a little concerned about the future of this project. Can we expect this project to remain maintained for the time being? If not, are there any viable alternatives which we can migrate to?

Thanks for the clarity.

[pawamoy]

These are good questions @MaddyGuthridge, thanks for reaching out 🙂

While mkdocstrings and handlers are now in maintenance mode, Griffe is not: I am still actively maintaining it, and will continue adding features to it. I might move it back to my own account (@pawamoy) to avoid this kind of confusion regarding maintenance.

In you're still interested in alternatives, we list some here: https://mkdocstrings.github.io/griffe/alternatives/, but most of them are either just prototypes, unmaintained, or serve different purposes. Happy to list any other alternative you can find!

[MaddyGuthridge]

I'm super glad that this project will continue to be maintained! It is a very useful library. I am considering forking mkdocstrings to support properdocs, the mkdocs@1 fork, although I will have to weigh up the maintenance burden, since I already have an enormous number of projects.

[pawamoy]

Of course, feel free to fork ☺️ Although if I understand correctly, all plugins already work in ProperDocs. But maybe you'd like to add features to it? Note that I'll still fix critical issues in mkdocstrings and handlers. We're just not adding new features.

[MaddyGuthridge]

I am mainly looking for the fork to depend on properdocs instead of mkdocs, so that installing the fork wouldn't cause as much bloat. I'd probably also make CI test against properdocs too, so that I could make sure it doesn't break on the fork, even as it is updated and improved.

If that's something you'd be interested in merging to the existing package, that would perhaps be even more ideal (even if not removing the mkdocs dependency entirely, at least testing against properdocs would be helpful).

[pawamoy]

I see, thanks 🙂 I wouldn't fix any issue relevant to ProperDocs so there's no point in testing against it CI ☺️ But you're welcome to do that in a fork.