Open chrisburr opened 5 years ago
What are ALICE using?
I'm probably blind; where do they test their code snippets?
IIRC they parse the sources using building/doc2dock.py
looking for snippets tagged with <!-- Dockerfile RUN_INLINE -->
(example). This is ran as a daily cron job in Travis.
MkDocs is visually clean and similar to GitBook, haven't really tested it out yet though. I'm still on the lookout for a Hugo solution; I've seen a few worth testing, and Hugo technically could support the multiple output formats, etc, but haven't found a solution that provides it yet.
At some point we should consider moving from GitBook to something else as the CLI interface we use is no longer maintained and contains various bugs. We could consider moving to CERN GitLab, but this would only apply to the LHCb repositories and we might not want to maintain multiple CI pipelines. I think the preference is to use a "popular" static site generator in the hope that we avoid being stuck with an abandonded tool.
Essential features:
Potentially desirable features: