Skip to content

Proposal: Migrate back to Sphinx for Localization #3839

@hwhsu1231

Description

@hwhsu1231

Describe the new feature you'd like

Hello Zarr-Python Team,

I am the author of the @localizethedocs organization, which focuses on creating localization projects for open-source documentation. And recently, I published the numpy-docs-l10n project as part of our ongoing efforts.

In short, Translations are contributed via the Crowdin platform, automatically synchronized with the GitHub repository, and can be previewed on GitHub Pages. Most importantly, the core of our infrastructure leverages Sphinx’s built-in Internationalization with Gettext feature, enabling us to generate and use standard .po translation files seamlessly.

As NumPy is part of the Scientific Python Core Projects, I have been following the Zarr-Python project closely and already added it to the todo list. However, I noticed that starting from the v3.1.4 tag (specifically this commit), the documentation has migrated from Sphinx to MkDocs.

I understand that the Zarr-Python team likely had thorough discussions before making this transition. If the primary motivation was to adopt the "Material for MkDocs" theme over the "PyData Sphinx Theme", I would like to suggest exploring the "Sphinx Immaterial" theme as a potential middle ground—a suggestion I noticed was also mentioned in issue #2894.

However, the main reason I bring this up is that @localizethedocs currently has a robust infrastructure built around Sphinx. If Zarr-Python documentation were to remain on Sphinx, I could seamlessly integrate it into our existing workflow to establish a dedicated localization project. It would be a pleasure to help bring Zarr-Python documentation to a wider global audience.

Therefore, I wonder whether it is possible to migrate the Zarr-Python documentation back to Sphinx.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions