Skip to content

Commit

Permalink
Switch to sphinx to be able to translate documentation
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jajm committed Jun 28, 2021
1 parent cc3dbde commit ad1a174
Show file tree
Hide file tree
Showing 59 changed files with 18,084 additions and 86 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
_build/
locales/**/*.mo
site/
.DS_Store
.DS_Store
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
18 changes: 0 additions & 18 deletions _docmap.md

This file was deleted.

68 changes: 68 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'Omeka S end user manual'
copyright = '2021, Omeka Team'
author = 'Omeka Team'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'myst_parser'
]

source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'_build',
'Thumbs.db',
'.DS_Store',
'README.md',
'style-guide.md',
'translation.md',
]


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

gettext_compact = False
gettext_uuid = True
2 changes: 0 additions & 2 deletions deploy

This file was deleted.

9 changes: 9 additions & 0 deletions docs/modules/scripto.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=========
Scripto
=========

.. toctree::
:glob:
:maxdepth: 2

scripto/*
36 changes: 36 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Welcome to Omeka S end user manual's documentation!
===================================================

.. toctree::
:hidden:
:glob:

docs/*

.. toctree::
:hidden:
:glob:
:caption: Sites

docs/sites/*

.. toctree::
:hidden:
:glob:
:caption: Resources

docs/content/*

.. toctree::
:hidden:
:glob:
:caption: Admin

docs/admin/*

.. toctree::
:hidden:
:glob:
:caption: Modules

docs/modules/*
110 changes: 110 additions & 0 deletions locales/fr/LC_MESSAGES/docs/accessibility.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2021, Omeka Team
# This file is distributed under the same license as the Omeka S end user
# manual package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2021.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Omeka S end user manual \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2021-06-28 08:33+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.9.1\n"

#: ../../docs/accessibility.md:1 6b3ffab98bcd42da98f13603fef81b2b
msgid "Accessibility Statement"
msgstr ""

#: ../../docs/accessibility.md:3 9e56e5ca96d7497fb3afa5125e08964e
msgid ""
"The Omeka team is committed to making Omeka S an accessible option for "
"building collections and exhibits online. We are working to make the core"
" code accessible and will continue to make accessibility for persons with"
" disabilities a priority as we develop the code. Omeka strives to adhere "
"to [W3C web design standards](http://www.w3.org/standards/) and to be "
"compliant with [Section 508](http://www.section508.gov/) of the Americans"
" with Disabilities Act (pdf)."
msgstr ""

#: ../../docs/accessibility.md:5 2dfeac3f4f0d4b17a6ff2a33b102101a
msgid "For more information, please review the following reports:"
msgstr ""

#: ../../docs/accessibility.md:6 9a71de450246454cb7b4aff19ed0d27e
msgid ""
"Omeka S version 3.x [Accessibility Conformance Report, using VPAT 2.4 "
"Revised International Standards](files/OmekaS3x_ACR.pdf) (pdf), October "
"2020."
msgstr ""

#: ../../docs/accessibility.md:7 111280def7b14e9282a48a449fcc7ee2
msgid ""
"Omeka S version 2.x [Accessibility Conformance Report using VPAT version "
"2.0](files/VPAT_OmekaS2-0-1.pdf) (pdf), August 2019."
msgstr ""

#: ../../docs/accessibility.md:8 6e1623d8c6fb4bffbc3e8cab5a7bfeb0
msgid ""
"Omeka S version 1.x [Accessibility Conformance Report using VPAT version "
"1.1](files/VPAT2.0-OmekaS1-1.pdf) (pdf), April 2018."
msgstr ""

#: ../../docs/accessibility.md:10 3a22d7f2993243edad8144858c0bc7c5
msgid "The following statements apply to Omeka S version 1.0.1 and higher:"
msgstr ""

#: ../../docs/accessibility.md:12 e2f01be578a2415dbb63bf2cbdef5b42
msgid "Front End (Public view)"
msgstr ""

#: ../../docs/accessibility.md:14 7773c6ea12e44ec38160584ed5b5ee5f
msgid ""
"The themes produced for Omeka S by RRCHNM have has the following features"
" to improve accessibility:"
msgstr ""

#: ../../docs/accessibility.md:16 cdbd27463b63484bbbda2e3080dcf5a0
msgid ""
"[ARIA](http://www.w3.org/WAI/intro/aria) (Accessible Rich Internet "
"Applications) landmarks for tabbing through page content, when not using "
"a mouse or using a screen reader;"
msgstr ""

#: ../../docs/accessibility.md:17 ../../docs/accessibility.md:26
#: 2d27a05db64f49c79a69a914098a0f99 d3fd51abf39e4184991ed5e7deedd522
msgid "Semantic HTML5 markup."
msgstr ""

#: ../../docs/accessibility.md:19 bdee655a96fd4512a078d46851dca2c7
msgid ""
"Please note that although the core code for Omeka S conform to the above "
"standards, installations of Omeka S which have been customized or which "
"are using non-RRCHNM modules and themes may lack some or all of these "
"options. While we encourage developers to consider accessibility, we "
"cannot guarantee that their code includes ARIA Landmarks, SkipNav, or "
"other accessibility considerations."
msgstr ""

#: ../../docs/accessibility.md:21 bbf569fc89b247e49b74f24d75ff39bd
msgid "Back End (Administrative view)"
msgstr ""

#: ../../docs/accessibility.md:23 db213b2c7c13402bb8b96fcb9387e7e3
msgid ""
"The administrative dashboard of Omeka S has the following features for "
"accessibility:"
msgstr ""

#: ../../docs/accessibility.md:25 02e1794147e74a1e83835a31d5ff878a
msgid ""
"ARIA landmarks for screen readers on the Admin Dashboard, designating the"
" header, navigation, main content, and footers."
msgstr ""

Loading

0 comments on commit ad1a174

Please sign in to comment.