mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fixup windows newlines.
This commit is contained in:
parent
df53ece2f7
commit
24d303706f
@ -1,9 +1,9 @@
|
||||
:tocdepth: 2
|
||||
|
||||
.. _authors:
|
||||
|
||||
Sphinx authors
|
||||
==============
|
||||
|
||||
.. include:: ../AUTHORS
|
||||
|
||||
:tocdepth: 2
|
||||
|
||||
.. _authors:
|
||||
|
||||
Sphinx authors
|
||||
==============
|
||||
|
||||
.. include:: ../AUTHORS
|
||||
|
||||
|
2
sphinx/themes/basic/static/jquery.js
vendored
2
sphinx/themes/basic/static/jquery.js
vendored
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
@ -1,89 +1,89 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
sphinx.util.i18n
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Builder superclass for all builders.
|
||||
|
||||
:copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
:license: BSD, see LICENSE for details.
|
||||
"""
|
||||
|
||||
from os import path
|
||||
from collections import namedtuple
|
||||
|
||||
from babel.messages.pofile import read_po
|
||||
from babel.messages.mofile import write_mo
|
||||
|
||||
from sphinx.util.osutil import walk
|
||||
|
||||
|
||||
LocaleFileInfoBase = namedtuple('CatalogInfo', 'base_dir,domain')
|
||||
|
||||
|
||||
class CatalogInfo(LocaleFileInfoBase):
|
||||
|
||||
@property
|
||||
def po_file(self):
|
||||
return self.domain + '.po'
|
||||
|
||||
@property
|
||||
def mo_file(self):
|
||||
return self.domain + '.mo'
|
||||
|
||||
@property
|
||||
def po_path(self):
|
||||
return path.join(self.base_dir, self.po_file)
|
||||
|
||||
@property
|
||||
def mo_path(self):
|
||||
return path.join(self.base_dir, self.mo_file)
|
||||
|
||||
def is_outdated(self):
|
||||
return (
|
||||
not path.exists(self.mo_path) or
|
||||
path.getmtime(self.mo_path) < path.getmtime(self.po_path))
|
||||
|
||||
def write_mo(self, locale):
|
||||
with open(self.po_path, 'rt') as po:
|
||||
with open(self.mo_path, 'wb') as mo:
|
||||
write_mo(mo, read_po(po, locale))
|
||||
|
||||
|
||||
def get_catalogs(locale_dirs, locale, gettext_compact=False, force_all=False):
|
||||
"""
|
||||
:param list locale_dirs:
|
||||
list of path as `['locale_dir1', 'locale_dir2', ...]` to find
|
||||
translation catalogs. Each path contains a structure such as
|
||||
`<locale>/LC_MESSAGES/domain.po`.
|
||||
:param str locale: a language as `'en'`
|
||||
:param boolean gettext_compact:
|
||||
* False: keep domains directory structure (default).
|
||||
* True: domains in the sub directory will be merged into 1 file.
|
||||
:param boolean force_all:
|
||||
Set True if you want to get all catalogs rather than updated catalogs.
|
||||
default is False.
|
||||
:return: [CatalogInfo(), ...]
|
||||
"""
|
||||
if not locale:
|
||||
return [] # locale is not specified
|
||||
|
||||
catalogs = set()
|
||||
for locale_dir in locale_dirs:
|
||||
base_dir = path.join(locale_dir, locale, 'LC_MESSAGES')
|
||||
|
||||
if not path.exists(base_dir):
|
||||
continue # locale path is not found
|
||||
|
||||
for dirpath, dirnames, filenames in walk(base_dir, followlinks=True):
|
||||
filenames = [f for f in filenames if f.endswith('.po')]
|
||||
for filename in filenames:
|
||||
base = path.splitext(filename)[0]
|
||||
domain = path.relpath(path.join(dirpath, base), base_dir)
|
||||
if gettext_compact and path.sep in domain:
|
||||
domain = path.split(domain)[0]
|
||||
cat = CatalogInfo(base_dir, domain)
|
||||
if force_all or cat.is_outdated():
|
||||
catalogs.add(cat)
|
||||
|
||||
return catalogs
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
sphinx.util.i18n
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Builder superclass for all builders.
|
||||
|
||||
:copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
:license: BSD, see LICENSE for details.
|
||||
"""
|
||||
|
||||
from os import path
|
||||
from collections import namedtuple
|
||||
|
||||
from babel.messages.pofile import read_po
|
||||
from babel.messages.mofile import write_mo
|
||||
|
||||
from sphinx.util.osutil import walk
|
||||
|
||||
|
||||
LocaleFileInfoBase = namedtuple('CatalogInfo', 'base_dir,domain')
|
||||
|
||||
|
||||
class CatalogInfo(LocaleFileInfoBase):
|
||||
|
||||
@property
|
||||
def po_file(self):
|
||||
return self.domain + '.po'
|
||||
|
||||
@property
|
||||
def mo_file(self):
|
||||
return self.domain + '.mo'
|
||||
|
||||
@property
|
||||
def po_path(self):
|
||||
return path.join(self.base_dir, self.po_file)
|
||||
|
||||
@property
|
||||
def mo_path(self):
|
||||
return path.join(self.base_dir, self.mo_file)
|
||||
|
||||
def is_outdated(self):
|
||||
return (
|
||||
not path.exists(self.mo_path) or
|
||||
path.getmtime(self.mo_path) < path.getmtime(self.po_path))
|
||||
|
||||
def write_mo(self, locale):
|
||||
with open(self.po_path, 'rt') as po:
|
||||
with open(self.mo_path, 'wb') as mo:
|
||||
write_mo(mo, read_po(po, locale))
|
||||
|
||||
|
||||
def get_catalogs(locale_dirs, locale, gettext_compact=False, force_all=False):
|
||||
"""
|
||||
:param list locale_dirs:
|
||||
list of path as `['locale_dir1', 'locale_dir2', ...]` to find
|
||||
translation catalogs. Each path contains a structure such as
|
||||
`<locale>/LC_MESSAGES/domain.po`.
|
||||
:param str locale: a language as `'en'`
|
||||
:param boolean gettext_compact:
|
||||
* False: keep domains directory structure (default).
|
||||
* True: domains in the sub directory will be merged into 1 file.
|
||||
:param boolean force_all:
|
||||
Set True if you want to get all catalogs rather than updated catalogs.
|
||||
default is False.
|
||||
:return: [CatalogInfo(), ...]
|
||||
"""
|
||||
if not locale:
|
||||
return [] # locale is not specified
|
||||
|
||||
catalogs = set()
|
||||
for locale_dir in locale_dirs:
|
||||
base_dir = path.join(locale_dir, locale, 'LC_MESSAGES')
|
||||
|
||||
if not path.exists(base_dir):
|
||||
continue # locale path is not found
|
||||
|
||||
for dirpath, dirnames, filenames in walk(base_dir, followlinks=True):
|
||||
filenames = [f for f in filenames if f.endswith('.po')]
|
||||
for filename in filenames:
|
||||
base = path.splitext(filename)[0]
|
||||
domain = path.relpath(path.join(dirpath, base), base_dir)
|
||||
if gettext_compact and path.sep in domain:
|
||||
domain = path.split(domain)[0]
|
||||
cat = CatalogInfo(base_dir, domain)
|
||||
if force_all or cat.is_outdated():
|
||||
catalogs.add(cat)
|
||||
|
||||
return catalogs
|
||||
|
@ -1,80 +1,80 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
## set this by test
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
from sphinx.writers.html import HTMLTranslator
|
||||
from sphinx.writers.latex import LaTeXTranslator
|
||||
from sphinx.writers.manpage import ManualPageTranslator
|
||||
from sphinx.writers.texinfo import TexinfoTranslator
|
||||
from sphinx.writers.text import TextTranslator
|
||||
from sphinx.writers.websupport import WebSupportTranslator
|
||||
from docutils.writers.docutils_xml import XMLTranslator
|
||||
|
||||
|
||||
project = 'test'
|
||||
master_doc = 'index'
|
||||
|
||||
|
||||
class ConfHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfDirHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfSingleHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfPickleTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfJsonTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfLaTeXTranslator(LaTeXTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfManualPageTranslator(ManualPageTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfTexinfoTranslator(TexinfoTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfTextTranslator(TextTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfWebSupportTranslator(WebSupportTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfXMLTranslator(XMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfPseudoXMLTranslator(XMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.set_translator('html', ConfHTMLTranslator)
|
||||
app.set_translator('dirhtml', ConfDirHTMLTranslator)
|
||||
app.set_translator('singlehtml', ConfSingleHTMLTranslator)
|
||||
app.set_translator('pickle', ConfPickleTranslator)
|
||||
app.set_translator('json', ConfJsonTranslator)
|
||||
app.set_translator('latex', ConfLaTeXTranslator)
|
||||
app.set_translator('man', ConfManualPageTranslator)
|
||||
app.set_translator('texinfo', ConfTexinfoTranslator)
|
||||
app.set_translator('text', ConfTextTranslator)
|
||||
app.set_translator('websupport', ConfWebSupportTranslator)
|
||||
app.set_translator('xml', ConfXMLTranslator)
|
||||
app.set_translator('pseudoxml', ConfPseudoXMLTranslator)
|
||||
# -*- coding: utf-8 -*-
|
||||
## set this by test
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
from sphinx.writers.html import HTMLTranslator
|
||||
from sphinx.writers.latex import LaTeXTranslator
|
||||
from sphinx.writers.manpage import ManualPageTranslator
|
||||
from sphinx.writers.texinfo import TexinfoTranslator
|
||||
from sphinx.writers.text import TextTranslator
|
||||
from sphinx.writers.websupport import WebSupportTranslator
|
||||
from docutils.writers.docutils_xml import XMLTranslator
|
||||
|
||||
|
||||
project = 'test'
|
||||
master_doc = 'index'
|
||||
|
||||
|
||||
class ConfHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfDirHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfSingleHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfPickleTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfJsonTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfLaTeXTranslator(LaTeXTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfManualPageTranslator(ManualPageTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfTexinfoTranslator(TexinfoTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfTextTranslator(TextTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfWebSupportTranslator(WebSupportTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfXMLTranslator(XMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
class ConfPseudoXMLTranslator(XMLTranslator):
|
||||
pass
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.set_translator('html', ConfHTMLTranslator)
|
||||
app.set_translator('dirhtml', ConfDirHTMLTranslator)
|
||||
app.set_translator('singlehtml', ConfSingleHTMLTranslator)
|
||||
app.set_translator('pickle', ConfPickleTranslator)
|
||||
app.set_translator('json', ConfJsonTranslator)
|
||||
app.set_translator('latex', ConfLaTeXTranslator)
|
||||
app.set_translator('man', ConfManualPageTranslator)
|
||||
app.set_translator('texinfo', ConfTexinfoTranslator)
|
||||
app.set_translator('text', ConfTextTranslator)
|
||||
app.set_translator('websupport', ConfWebSupportTranslator)
|
||||
app.set_translator('xml', ConfXMLTranslator)
|
||||
app.set_translator('pseudoxml', ConfPseudoXMLTranslator)
|
||||
|
@ -1,3 +1,3 @@
|
||||
=======================
|
||||
Test API set_translator
|
||||
=======================
|
||||
Test API set_translator
|
||||
=======================
|
@ -1,9 +1,9 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
|
||||
|
||||
project = 'test'
|
||||
master_doc = 'index'
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
|
||||
|
||||
project = 'test'
|
||||
master_doc = 'index'
|
||||
|
@ -1,6 +1,6 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from sphinx.writers.html import HTMLTranslator
|
||||
|
||||
class ExtHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from sphinx.writers.html import HTMLTranslator
|
||||
|
||||
class ExtHTMLTranslator(HTMLTranslator):
|
||||
pass
|
||||
|
@ -1,15 +1,15 @@
|
||||
docutils conf
|
||||
=============
|
||||
|
||||
field-name-limit
|
||||
----------------
|
||||
|
||||
:short: desc
|
||||
:long long long long: long title
|
||||
|
||||
option-limit
|
||||
------------
|
||||
|
||||
--short short desc
|
||||
--long-long-long-long long desc
|
||||
|
||||
docutils conf
|
||||
=============
|
||||
|
||||
field-name-limit
|
||||
----------------
|
||||
|
||||
:short: desc
|
||||
:long long long long: long title
|
||||
|
||||
option-limit
|
||||
------------
|
||||
|
||||
--short short desc
|
||||
--long-long-long-long long desc
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
from __future__ import absolute_import
|
||||
|
||||
from .mod1 import func1, Class1
|
||||
from .mod2 import (
|
||||
func2,
|
||||
Class2,
|
||||
)
|
||||
from __future__ import absolute_import
|
||||
|
||||
from .mod1 import func1, Class1
|
||||
from .mod2 import (
|
||||
func2,
|
||||
Class2,
|
||||
)
|
||||
|
@ -1,15 +1,15 @@
|
||||
"""
|
||||
mod1
|
||||
"""
|
||||
|
||||
def func1(a, b):
|
||||
"""
|
||||
this is func1
|
||||
"""
|
||||
return a, b
|
||||
|
||||
|
||||
class Class1(object):
|
||||
"""
|
||||
this is Class1
|
||||
"""
|
||||
"""
|
||||
mod1
|
||||
"""
|
||||
|
||||
def func1(a, b):
|
||||
"""
|
||||
this is func1
|
||||
"""
|
||||
return a, b
|
||||
|
||||
|
||||
class Class1(object):
|
||||
"""
|
||||
this is Class1
|
||||
"""
|
||||
|
@ -1,15 +1,15 @@
|
||||
"""
|
||||
mod2
|
||||
"""
|
||||
|
||||
def func2(a, b):
|
||||
"""
|
||||
this is func2
|
||||
"""
|
||||
return a, b
|
||||
|
||||
|
||||
class Class2(object):
|
||||
"""
|
||||
this is Class2
|
||||
"""
|
||||
"""
|
||||
mod2
|
||||
"""
|
||||
|
||||
def func2(a, b):
|
||||
"""
|
||||
this is func2
|
||||
"""
|
||||
return a, b
|
||||
|
||||
|
||||
class Class2(object):
|
||||
"""
|
||||
this is Class2
|
||||
"""
|
||||
|
@ -1,15 +1,15 @@
|
||||
:tocdepth: 2
|
||||
|
||||
i18n with python domain refs
|
||||
=============================
|
||||
|
||||
.. currentmodule:: sensitive
|
||||
|
||||
See this decorator: :func:`sensitive_variables`.
|
||||
|
||||
.. function:: sensitive_variables(*variables)
|
||||
|
||||
Some description
|
||||
|
||||
.. currentmodule:: reporting
|
||||
|
||||
:tocdepth: 2
|
||||
|
||||
i18n with python domain refs
|
||||
=============================
|
||||
|
||||
.. currentmodule:: sensitive
|
||||
|
||||
See this decorator: :func:`sensitive_variables`.
|
||||
|
||||
.. function:: sensitive_variables(*variables)
|
||||
|
||||
Some description
|
||||
|
||||
.. currentmodule:: reporting
|
||||
|
||||
|
@ -1,2 +1,2 @@
|
||||
subdir contents
|
||||
===============
|
||||
subdir contents
|
||||
===============
|
||||
|
@ -1,5 +1,5 @@
|
||||
contents
|
||||
=========
|
||||
|
||||
spam egg ham
|
||||
|
||||
contents
|
||||
=========
|
||||
|
||||
spam egg ham
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user