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.

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

Translations #58

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tests/books/test-otherlang/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)
53 changes: 53 additions & 0 deletions tests/books/test-otherlang/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 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 = "sphinx-exercise Test"
copyright = "2020, QuantEcon Developers"
author = "QuantEcon Developers"


# -- 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 = ["sphinx_exercise", "myst_nb"]

# 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 = []


# -- 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 = "alabaster"

# 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']

language = 'fr'
7 changes: 7 additions & 0 deletions tests/books/test-otherlang/exercise/_exercice.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
_exercice
===================

.. exercise::
:label: text-exc-notitle

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
9 changes: 9 additions & 0 deletions tests/books/test-otherlang/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
A Test Program!
===============

.. toctree::
:maxdepth: 1
:hidden:

exercise/_exercice

35 changes: 35 additions & 0 deletions tests/books/test-otherlang/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
11 changes: 11 additions & 0 deletions tests/test_translation.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from bs4 import BeautifulSoup
import pytest

@pytest.mark.sphinx("html", testroot="otherlang")
def test_translation(app, file_regression):
idir = "_exercice.html"
app.build()
path_exc_directive = app.outdir / "exercise" / idir
soup = BeautifulSoup(path_exc_directive.read_text(encoding="utf8"), "html.parser")
excs = soup.select("div.exercise")[0]
file_regression.check(str(excs), basename=idir.split(".")[0], extension=".html")
6 changes: 6 additions & 0 deletions tests/test_translation/_exercice.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div class="exercise admonition" id="text-exc-notitle">
<p class="admonition-title"><span class="caption-number">Exercice 1 </span></p>
<section id="exercise-content">
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
</section>
</div>
10 changes: 10 additions & 0 deletions tests/test_translation/_exercice.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<document source="_exercice.rst">
<section ids="exercice" names="_exercice">
<title>
_enum_notitle_label
<exercise_enumerable_node classes="exercise" docname="exercise/_exercice" hidden="False" ids="text-exc-notitle" label="text-exc-notitle" names="text-exc-notitle" serial_number="0" title="Exercise" type="exercise">
<exercise_title>
Exercise
<section ids="exercise-content">
<paragraph>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.