search

jimporter / mike

Manage multiple versions of your MkDocs-powered documentation via Git
BSD 3-Clause "New" or "Revised" License
528 stars 47 forks source link

usage with mkdocs-multirepo #109

Closed A-Baji closed 2 years ago

A-Baji commented 2 years ago

I am trying to create a documentation hub for various projects using mkdocs-multirepo. I would like to implement mike versioning for the child docs, but not the parent. I have mike working in the child repositories, but when accessing them through the parent hub it does not work since the multirepo tool creates submodules for the specified repositories, and then builds each's docs with vanilla mkdocs.

I'm wondering if there's any work around for this?

jimporter commented 2 years ago

If multirepo is driving the documentation build process, then it would need to add some configurability to be able to adjust the command to run for building each submodule. Specifically, this line would need to be updated: https://github.com/wilhelmer/mkdocs-multirepo/blob/d6390fea1ea4326ea392497e4454b48915a13134/mkdocs_multirepo/__init__.py#L70

Closing, as there's nothing mike can do about this (since it's not being invoked in the first place).

A-Baji commented 2 years ago

What command would need to be called instead on line 70 then? I could be wrong but I don't think mike has a standard build command. The only way to build is on deployment, which requires a version input.

There is also the issue that the submodules wont have access to past versions, as they don't exist in the source code, only in gh-pages, so even if I can build the submodules with mike, they wouldn't have any versions to select from.

jimporter commented 2 years ago

If that's what mkdocs-multirepo needs, then unfortunately the two tools just aren't compatible. mike 100% relies on being able to manage old versions of the generated docs in gh-pages.