From df8f43d85d10225e622db133d829d1867b8bcb17 Mon Sep 17 00:00:00 2001 From: Carlos Muniz Date: Mon, 7 Mar 2022 11:16:31 -0500 Subject: [PATCH] feat: Add initial Translation Procs Docs Structure --- en_us/translation_processes/Makefile | 39 ++++++++++++++++++++ en_us/translation_processes/source/conf.py | 14 +++++++ en_us/translation_processes/source/index.rst | 20 ++++++++++ 3 files changed, 73 insertions(+) create mode 100644 en_us/translation_processes/Makefile create mode 100644 en_us/translation_processes/source/conf.py create mode 100644 en_us/translation_processes/source/index.rst diff --git a/en_us/translation_processes/Makefile b/en_us/translation_processes/Makefile new file mode 100644 index 0000000000..b07fbd8b63 --- /dev/null +++ b/en_us/translation_processes/Makefile @@ -0,0 +1,39 @@ +# 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 +PAPER ?= +SOURCEDIR = source +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +Q_FLAG = + +ifeq ($(quiet), true) +Q_FLAG = -Q +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +# 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) diff --git a/en_us/translation_processes/source/conf.py b/en_us/translation_processes/source/conf.py new file mode 100644 index 0000000000..575798c132 --- /dev/null +++ b/en_us/translation_processes/source/conf.py @@ -0,0 +1,14 @@ +import sys + +sys.path.append('../../../') + +from shared.conf import * + +project = u'Open edX Translation Processes' + +set_audience(OPENEDX, DEVELOPERS) + +exclude_patterns = ['links.rst'] + +def setup(app): + app.add_config_value('product', '', True) diff --git a/en_us/translation_processes/source/index.rst b/en_us/translation_processes/source/index.rst new file mode 100644 index 0000000000..69e3a2f69e --- /dev/null +++ b/en_us/translation_processes/source/index.rst @@ -0,0 +1,20 @@ +.. Translation Processes documentation master file, created by + sphinx-quickstart on Fri Mar 4 11:45:59 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Translation Processes's documentation! +================================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`