Build on Read the Docs

humitos · humitos · commit fe3249bae627 · 2020-05-01T20:54:03.000+02:00
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,5 @@
+[submodule "cpython"]
+	path = cpython
+	url = https://github.com/python/cpython.git
+	branch = 3.7
+	shallow = true
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,19 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: cpython/Doc/conf.py
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: requirements.txt
+
+submodules:
+  include: all
diff --git a/conf.py b/conf.py
@@ -0,0 +1,84 @@
+import sys, os, time
+sys.path.append(os.path.abspath('cpython/Doc/tools/extensions'))
+sys.path.append(os.path.abspath('cpython/Doc/includes'))
+
+# General configuration
+# ---------------------
+
+extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest',
+              'pyspecific', 'c_annotations', 'escape4chm']
+
+
+project = 'Python en Español'
+copyright = '2001-%s, Python Software Foundation' % time.strftime('%Y')
+
+release = version = 3.7
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+today = ''
+# Else, today_fmt is used as the format for a strftime call.
+today_fmt = '%B %d, %Y'
+
+# By default, highlight as Python 3.
+highlight_language = 'python3'
+
+# Minimum version of sphinx required
+needs_sphinx = '1.8'
+
+# Ignore any .rst files in the venv/ directory.
+exclude_patterns = ['venv/*', 'README.rst']
+
+# Avoid a warning with Sphinx >= 2.0
+master_doc = 'contents'
+
+# Use our custom theme.
+html_theme = 'python_docs_theme'
+html_theme_path = ['cpython/Doc/tools']
+html_theme_options = {
+    'collapsiblesidebar': True,
+    'issues_url': 'https://docs.python.org/3/bugs.html',
+    'root_include_title': False   # We use the version switcher instead.
+}
+
+# Short title used e.g. for <title> HTML tags.
+html_short_title = '%s Documentation' % release
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# Path to find HTML templates.
+templates_path = ['cpython/Doc/tools/templates']
+
+# Custom sidebar templates, filenames relative to this file.
+html_sidebars = {
+    # Defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
+    # Removes the quick search block
+    '**': ['localtoc.html', 'relations.html', 'customsourcelink.html'],
+    'index': ['indexsidebar.html'],
+}
+
+# Additional templates that should be rendered to pages.
+html_additional_pages = {
+    'download': 'download.html',
+    'index': 'indexcontent.html',
+}
+
+# Output an OpenSearch description file.
+html_use_opensearch = 'https://docs.python.org/' + version
+
+# Additional static files.
+html_static_path = ['cpython/Doc/tools/static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python' + release.replace('.', '')
+
+# Split the index
+html_split_index = True
+
+# Relative filename of the reference count data file.
+refcount_file = 'data/refcounts.dat'
+
+
+os.system('ln -nfs `pwd` cpython/locales/es/LC_MESSAGES')
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+Sphinx==2.2.0
+setuptools
+blurb
+python-docs-theme
