Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch to sphinx to be able to translate documentation #98

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Switch to sphinx to be able to translate documentation #98

wants to merge 2 commits into from

Commits on Sep 1, 2022

  1. Switch to sphinx to be able to translate documentation 

    We needed to translate in french the Omeka S's documentation, and mkdocs
does not fit our needs. Sphinx provides by default all the tools needed
to translate with PO files and generate translated documentation. The
generated documentation is the same as if it was generated by mkdocs.

Ideally, we think that all the PO files should be in the official
documentation repository, and they could be modified on Transifex, so
that anyone can participate to translation.

Instructions for translating are written inside translation.md
    @jajm
    jajm committed Sep 1, 2022
    Configuration menu
    Copy the full SHA
    7f32292 View commit details
    Browse the repository at this point in the history

  2. Remove {target=_blank} everywhere 

    It is a syntax extension that is not supported by MyST

Instead, add a line of javascript to add this attribute to all
<a> elements that have the `external` class. This class is added by
sphinx automatically
    @jajm
    jajm committed Sep 1, 2022
    Configuration menu
    Copy the full SHA
    1e53216 View commit details
    Browse the repository at this point in the history