Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Build on Read the Docs #24

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.

Sign up for GitHub

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

Merged
merged 17 commits into from
May 2, 2020
Merged

Build on Read the Docs #24

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
fe3249b
Build on Read the Docs
humitos May 1, 2020
98633b2
Path to conf.py
humitos May 1, 2020
8a35ff3
Make version a string
humitos May 1, 2020
028a81e
Submodule 3.7
humitos May 1, 2020
9914c62
Create locales directories
humitos May 1, 2020
af6e79f
How I do create the submodule pinned to a commit
humitos May 1, 2020
582dfcf
refcount data path
humitos May 1, 2020
90e146b
Add some help to the conf.py file
humitos May 1, 2020
e323a8f
Locale Sphinx configs
humitos May 1, 2020
68151c5
Make the build to use the proper sourcedir
humitos May 1, 2020
069fdfc
Example of running with sphinx-build
humitos May 1, 2020
bc125aa
Correct Python version
humitos May 1, 2020
7822224
Locale is relative to sourcedir
humitos May 1, 2020
6ad97e8
Without this path the index is not translated
humitos May 1, 2020
5dd76e9
Reduce the overrides and re-use as much as possible
humitos May 1, 2020
62b4db9
Small doc change
humitos May 1, 2020
309ef1f
version != release
humitos May 1, 2020
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
Prev Previous commit
Next Next commit
Reduce the overrides and re-use as much as possible
  • Loading branch information
@humitos
humitos committed May 1, 2020
commit 5dd76e90bfac1cc34fdbf5d77e53062e4974922f
75 changes: 4 additions & 71 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,92 +18,25 @@
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']
# Import all the Sphinx settings from cpython
sys.path.append(os.path.abspath('cpython/Doc'))
from conf import *

release = version = '3.7.7'

project = 'Python en Español'
copyright = '2001-%s, Python Software Foundation' % time.strftime('%Y')

release = version = '3.7.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('mkdir -p cpython/locales/es/')
os.system('ln -nfs `pwd` cpython/locales/es/LC_MESSAGES')

gettext_compact = False
locale_dirs = ['../locales', 'cpython/locales'] # relative to the sourcedir


def setup(app):
# Change the sourcedir programmatically because Read the Docs always call it with `.`
app.srcdir = 'cpython/Doc'