Skip to content

Commit cd746cc

Browse files
StanFromIrelandStanFromIreland
authored
Add sphinx and readthedocs (#106)
1 parent 4e0d632 commit cd746cc

File tree

6 files changed

+139
-0
lines changed

6 files changed

+139
-0
lines changed

‎.readthedocs.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version, and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
# Optionally, but recommended,
18+
# declare the Python requirements required to build your documentation
19+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- requirements: docs/requirements.txt

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR =
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/conf.py‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'Python Docs Transifex Translations'
10+
copyright = '2025, rffontenelle'
11+
author = 'rffontenelle'
12+
13+
# -- General configuration ---------------------------------------------------
14+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
15+
16+
extensions = []
17+
18+
templates_path = ['_templates']
19+
exclude_patterns = []
20+
21+
# -- Options for HTML output -------------------------------------------------
22+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
23+
24+
html_theme = 'furo'
25+
html_static_path = ['_static']

‎docs/index.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. Python Docs Transifex Translations documentation master file, created by
2+
sphinx-quickstart on Sun Jan 26 11:03:05 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Python Docs Transifex Translations documentation
7+
================================================
8+
9+
Scripts and procedures for maintaining Python_ documentation translation infrastructure under python-doc_ organization in Transifex_.
10+
11+
Source strings are updated using continuous integration workflow under *.github/workflows*. Details:
12+
13+
- Run weekly
14+
- Run for releases in beta, release candidate, stable, bugfixes and security-fixes status; alpha or EOL are excluded;
15+
- It DOES NOT store translations to be used by the published documentation;
16+
17+
See docs_ directory for more information on this project maintenance.
18+
19+
See Translating_ in Python Developer's Guide for more information.
20+
21+
.. _Python: https://www.python.org
22+
.. _python-doc: https://app.transifex.com/python-doc/
23+
.. _Transifex: https://www.transifex.com
24+
.. _docs: https://github.com/rffontenelle/docspush-transifex/blob/main/docs/
25+
.. _Translating: https://devguide.python.org/documentation/translating/
26+
27+
.. toctree::
28+
:maxdepth: 2
29+
:caption: Contents:
30+
31+
new-translators.rst
32+
bumping-relsease.rst
33+
commands.rst
34+
placeholders.rst
35+

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx>=8.0.0
2+
furo

0 commit comments

Comments
 (0)