diff --git a/CHANGES b/CHANGES index 33b6deb84..d5a3d87a4 100644 --- a/CHANGES +++ b/CHANGES @@ -15,6 +15,11 @@ Bugs fixed * #1340: Can't search alphabetical words on the HTML quick search generated with language='ja'. +Documentation +------------- + +* #1325: Added a "Intersphinx" tutorial section. (:file:`doc/tutorial.rst`) + Release 1.2 (released Dec 10, 2013) =================================== diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 9fea11dbe..8e949d4c5 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -248,11 +248,40 @@ Therefore, you must add the appropriate path to :py:data:`sys.path` in your |more| See :mod:`sphinx.ext.autodoc` for the complete description of the features of autodoc. +Intersphinx +----------- + +Many Sphinx documents including the `Python documentation`_ are published on the +internet. When you want to make links to such documents from your +documentation, you can do it with :mod:`sphinx.ext.intersphinx`. + +.. _Python documentation: http://docs.python.org/3 + +In order to use intersphinx, you need to activate it in :file:`conf.py` by +putting the string ``'sphinx.ext.intersphinx'`` into the :confval:`extensions` +list and set up the :confval:`intersphinx_mapping` config value. + +For example, to link to ``io.open()`` in the Python library manual, you need to +setup your :confval:`intersphinx_mapping` like:: + + intersphinx_mapping = {'python': ('http://docs.python.org/3', None)} + +And now, you can write a cross-reference like ``:py:func:`io.open```. Any +cross-reference that has no matching target in the current documentation set, +will be looked up in the documentation sets configured in +:confval:`intersphinx_mapping` (this needs access to the URL in order to +download the list of valid targets). Intersphinx also works for some other +:ref:`domains' ` roles including ``:ref:``, however it doesn't work for +``:doc:`` as that is non-domain role. + +|more| See :mod:`sphinx.ext.intersphinx` for the complete description of the +features of intersphinx. + More topics to be covered ------------------------- -- Other extensions (math, intersphinx, viewcode, doctest) +- Other extensions (math, viewcode, doctest) - Static files - Selecting a theme - Templating diff --git a/sphinx/locale/cs/LC_MESSAGES/sphinx.mo b/sphinx/locale/cs/LC_MESSAGES/sphinx.mo index 972f39de1..79f228532 100644 Binary files a/sphinx/locale/cs/LC_MESSAGES/sphinx.mo and b/sphinx/locale/cs/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/cs/LC_MESSAGES/sphinx.po b/sphinx/locale/cs/LC_MESSAGES/sphinx.po index 2a4722dcf..76b26189d 100644 --- a/sphinx/locale/cs/LC_MESSAGES/sphinx.po +++ b/sphinx/locale/cs/LC_MESSAGES/sphinx.po @@ -9,8 +9,8 @@ msgstr "" "Project-Id-Version: Sphinx\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" "POT-Creation-Date: 2013-04-02 10:33+0200\n" -"PO-Revision-Date: 2013-04-02 15:12+0000\n" -"Last-Translator: birkenfeld \n" +"PO-Revision-Date: 2013-12-26 13:32+0000\n" +"Last-Translator: pm13 \n" "Language-Team: Czech (http://www.transifex.com/projects/p/sphinx-1/language/cs/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -22,21 +22,21 @@ msgstr "" #: sphinx/config.py:81 #, python-format msgid "%s %s documentation" -msgstr "" +msgstr "Dokumentace pro %s %s" #: sphinx/environment.py:1510 #, python-format msgid "see %s" -msgstr "" +msgstr "viz %s" #: sphinx/environment.py:1513 #, python-format msgid "see also %s" -msgstr "" +msgstr "viz také %s" #: sphinx/environment.py:1570 msgid "Symbols" -msgstr "" +msgstr "Symboly" #: sphinx/roles.py:175 #, python-format @@ -55,7 +55,7 @@ msgstr "Vestavěné funkce" #: sphinx/builders/changes.py:75 msgid "Module level" -msgstr "Úroveň modulů" +msgstr "Úroveň modulu" #: sphinx/builders/html.py:290 #, python-format @@ -64,11 +64,11 @@ msgstr "%d.%m.%Y" #: sphinx/builders/html.py:309 sphinx/themes/basic/defindex.html:30 msgid "General Index" -msgstr "Rejstřík indexů" +msgstr "Obecný rejstřík" #: sphinx/builders/html.py:309 msgid "index" -msgstr "index" +msgstr "rejstřík" #: sphinx/builders/html.py:369 msgid "next" @@ -80,7 +80,7 @@ msgstr "předchozí" #: sphinx/builders/latex.py:141 sphinx/builders/texinfo.py:196 msgid " (in " -msgstr "(v" +msgstr " (v " #: sphinx/directives/other.py:138 msgid "Section author: " @@ -92,7 +92,7 @@ msgstr "Autor modulu: " #: sphinx/directives/other.py:142 msgid "Code author: " -msgstr "" +msgstr "Autor kódu:" #: sphinx/directives/other.py:144 msgid "Author: " @@ -101,7 +101,7 @@ msgstr "Autor: " #: sphinx/domains/__init__.py:244 #, python-format msgid "%s %s" -msgstr "" +msgstr "%s %s" #: sphinx/domains/c.py:51 sphinx/domains/cpp.py:939 #: sphinx/domains/python.py:95 @@ -126,7 +126,7 @@ msgstr "%s (C funkce)" #: sphinx/domains/c.py:143 #, python-format msgid "%s (C member)" -msgstr "%s (člen C)" +msgstr "%s (C člen)" #: sphinx/domains/c.py:145 #, python-format @@ -154,7 +154,7 @@ msgstr "člen" #: sphinx/domains/c.py:205 msgid "macro" -msgstr "" +msgstr "makro" #: sphinx/domains/c.py:206 sphinx/domains/cpp.py:1209 msgid "type" @@ -162,11 +162,11 @@ msgstr "typ" #: sphinx/domains/c.py:207 msgid "variable" -msgstr "" +msgstr "proměnná" #: sphinx/domains/cpp.py:942 sphinx/domains/javascript.py:125 msgid "Throws" -msgstr "" +msgstr "Vyvolá" #: sphinx/domains/cpp.py:1038 #, python-format @@ -181,7 +181,7 @@ msgstr "%s (C++ typ)" #: sphinx/domains/cpp.py:1081 #, python-format msgid "%s (C++ member)" -msgstr "%s (člen C++)" +msgstr "%s (C++ člen)" #: sphinx/domains/cpp.py:1137 #, python-format @@ -211,20 +211,20 @@ msgstr "%s() (třída)" #: sphinx/domains/javascript.py:111 #, python-format msgid "%s (global variable or constant)" -msgstr "" +msgstr "%s (globální proměnná nebo konstanta)" #: sphinx/domains/javascript.py:113 sphinx/domains/python.py:355 #, python-format msgid "%s (%s attribute)" -msgstr "%s() (atribut %s)" +msgstr "%s (atribut %s)" #: sphinx/domains/javascript.py:122 msgid "Arguments" -msgstr "" +msgstr "Argumenty" #: sphinx/domains/javascript.py:166 sphinx/domains/python.py:561 msgid "data" -msgstr "" +msgstr "data" #: sphinx/domains/javascript.py:167 sphinx/domains/python.py:567 msgid "attribute" @@ -232,7 +232,7 @@ msgstr "atribut" #: sphinx/domains/python.py:100 msgid "Variables" -msgstr "" +msgstr "Proměnné" #: sphinx/domains/python.py:104 msgid "Raises" @@ -247,22 +247,22 @@ msgstr "%s() (v modulu %s)" #: sphinx/domains/python.py:257 #, python-format msgid "%s (built-in variable)" -msgstr "%s() (vestavěná proměnná)" +msgstr "%s (vestavěná proměnná)" #: sphinx/domains/python.py:258 sphinx/domains/python.py:349 #, python-format msgid "%s (in module %s)" -msgstr "%s() (v modulu %s)" +msgstr "%s (v modulu %s)" #: sphinx/domains/python.py:274 #, python-format msgid "%s (built-in class)" -msgstr "%s () (vestavěná proměnná)" +msgstr "%s (vestavěná třída)" #: sphinx/domains/python.py:275 #, python-format msgid "%s (class in %s)" -msgstr "%s() (třída v %s)" +msgstr "%s (třída v %s)" #: sphinx/domains/python.py:315 #, python-format @@ -282,26 +282,26 @@ msgstr "%s() (statická metoda %s)" #: sphinx/domains/python.py:340 #, python-format msgid "%s() (%s.%s class method)" -msgstr "" +msgstr "%s() (třídní metoda %s.%s)" #: sphinx/domains/python.py:343 #, python-format msgid "%s() (%s class method)" -msgstr "" +msgstr "%s() (třídní metoda %s)" #: sphinx/domains/python.py:353 #, python-format msgid "%s (%s.%s attribute)" -msgstr "%s() (atribut %s.%s)" +msgstr "%s (atribut %s.%s)" #: sphinx/domains/python.py:434 #, python-format msgid "%s (module)" -msgstr "%s (module)" +msgstr "%s (modul)" #: sphinx/domains/python.py:491 msgid "Python Module Index" -msgstr "" +msgstr "Rejstřík modulů Pythonu" #: sphinx/domains/python.py:492 msgid "modules" @@ -317,11 +317,11 @@ msgstr "výjimka" #: sphinx/domains/python.py:564 msgid "method" -msgstr "" +msgstr "metoda" #: sphinx/domains/python.py:565 msgid "class method" -msgstr "" +msgstr "třídní metoda" #: sphinx/domains/python.py:566 msgid "static method" @@ -338,50 +338,50 @@ msgstr " (zastaralé)" #: sphinx/domains/rst.py:53 #, python-format msgid "%s (directive)" -msgstr "" +msgstr "%s (direktiva)" #: sphinx/domains/rst.py:55 #, python-format msgid "%s (role)" -msgstr "" +msgstr "%s (role)" #: sphinx/domains/rst.py:104 msgid "directive" -msgstr "" +msgstr "direktiva" #: sphinx/domains/rst.py:105 msgid "role" -msgstr "" +msgstr "role" #: sphinx/domains/std.py:70 sphinx/domains/std.py:86 #, python-format msgid "environment variable; %s" -msgstr "promměná prostředí, %s" +msgstr "proměnná prostředí; %s" #: sphinx/domains/std.py:162 #, python-format msgid "%scommand line option; %s" -msgstr "%s parametry příkazového řádku; %s" +msgstr "%svolba příkazového řádku; %s" #: sphinx/domains/std.py:414 msgid "glossary term" -msgstr "" +msgstr "termín v glosáři" #: sphinx/domains/std.py:415 msgid "grammar token" -msgstr "" +msgstr "token gramatiky" #: sphinx/domains/std.py:416 msgid "reference label" -msgstr "" +msgstr "referenční návěstí" #: sphinx/domains/std.py:418 msgid "environment variable" -msgstr "promměná prostředí" +msgstr "proměnná prostředí" #: sphinx/domains/std.py:419 msgid "program option" -msgstr "" +msgstr "volba programu" #: sphinx/domains/std.py:449 sphinx/themes/basic/genindex-single.html:32 #: sphinx/themes/basic/genindex-single.html:57 @@ -391,11 +391,11 @@ msgstr "" #: sphinx/themes/basic/genindex.html:68 sphinx/themes/basic/layout.html:134 #: sphinx/writers/latex.py:191 sphinx/writers/texinfo.py:475 msgid "Index" -msgstr "Index" +msgstr "Rejstřík" #: sphinx/domains/std.py:450 msgid "Module Index" -msgstr "Rejstřík modulů " +msgstr "Rejstřík modulů" #: sphinx/domains/std.py:451 sphinx/themes/basic/defindex.html:25 msgid "Search Page" @@ -404,42 +404,42 @@ msgstr "Vyhledávací stránka" #: sphinx/ext/autodoc.py:1042 #, python-format msgid " Bases: %s" -msgstr "" +msgstr " Nadtřídy: %s" #: sphinx/ext/autodoc.py:1078 #, python-format msgid "alias of :class:`%s`" -msgstr "" +msgstr "alias třídy :class:`%s`" #: sphinx/ext/graphviz.py:294 sphinx/ext/graphviz.py:302 #, python-format msgid "[graph: %s]" -msgstr "" +msgstr "[graf: %s]" #: sphinx/ext/graphviz.py:296 sphinx/ext/graphviz.py:304 msgid "[graph]" -msgstr "" +msgstr "[graf]" #: sphinx/ext/intersphinx.py:234 #, python-format msgid "(in %s v%s)" -msgstr "" +msgstr "(v %s v%s)" #: sphinx/ext/linkcode.py:66 sphinx/ext/viewcode.py:70 msgid "[source]" -msgstr "" +msgstr "[zdroj]" #: sphinx/ext/refcounting.py:83 msgid "Return value: Always NULL." -msgstr "" +msgstr "Navrácená hodnota: Vždy NULL." #: sphinx/ext/refcounting.py:85 msgid "Return value: New reference." -msgstr "" +msgstr "Navrácená hodnota: Nová reference." #: sphinx/ext/refcounting.py:87 msgid "Return value: Borrowed reference." -msgstr "" +msgstr "Navrácená hodnota: Vypůjčená reference." #: sphinx/ext/todo.py:42 msgid "Todo" @@ -448,32 +448,32 @@ msgstr "Todo" #: sphinx/ext/todo.py:110 #, python-format msgid "(The <> is located in %s, line %d.)" -msgstr "" +msgstr "(<> se nachází v %s, řádka %d.)" #: sphinx/ext/todo.py:119 msgid "original entry" -msgstr "" +msgstr "původní záznam" #: sphinx/ext/viewcode.py:117 msgid "[docs]" -msgstr "" +msgstr "[dokumentace]" #: sphinx/ext/viewcode.py:131 msgid "Module code" -msgstr "" +msgstr "Kód modulu" #: sphinx/ext/viewcode.py:137 #, python-format msgid "

Source code for %s

" -msgstr "" +msgstr "

Zdrojový kód pro %s

" #: sphinx/ext/viewcode.py:164 msgid "Overview: module code" -msgstr "" +msgstr "Přehled: kód modulu" #: sphinx/ext/viewcode.py:165 msgid "

All modules for which code is available

" -msgstr "" +msgstr "

Všechny moduly s dostupným kódem

" #: sphinx/locale/__init__.py:155 msgid "Attention" @@ -559,15 +559,15 @@ msgstr "Obsah" #: sphinx/themes/basic/search.html:11 sphinx/themes/basic/search.html:23 #: sphinx/themes/basic/searchresults.html:10 msgid "Search" -msgstr "Hledání" +msgstr "Vyhledávání" #: sphinx/themes/agogo/layout.html:53 sphinx/themes/basic/searchbox.html:15 msgid "Go" -msgstr "hledej" +msgstr "OK" #: sphinx/themes/agogo/layout.html:58 sphinx/themes/basic/searchbox.html:20 msgid "Enter search terms or a module, class or function name." -msgstr "" +msgstr "Zadejte hledané termíny nebo jméno modulu, třídy či funkce." #: sphinx/themes/agogo/layout.html:79 sphinx/themes/basic/sourcelink.html:14 msgid "Show Source" @@ -579,15 +579,15 @@ msgstr "Přehled" #: sphinx/themes/basic/defindex.html:15 msgid "Welcome! This is" -msgstr "" +msgstr "Vítejte! Toto je" #: sphinx/themes/basic/defindex.html:16 msgid "the documentation for" -msgstr "" +msgstr "dokumentace pro" #: sphinx/themes/basic/defindex.html:17 msgid "last updated" -msgstr "" +msgstr "naposledy aktualizováno" #: sphinx/themes/basic/defindex.html:20 msgid "Indices and tables:" @@ -603,7 +603,7 @@ msgstr "seznam všech sekcí a podsekcí" #: sphinx/themes/basic/defindex.html:26 msgid "search this documentation" -msgstr "prohledej tuto dokumentaci" +msgstr "prohledat tuto dokumentaci" #: sphinx/themes/basic/defindex.html:28 msgid "Global Module Index" @@ -620,18 +620,18 @@ msgstr "všechny funkce, třídy, termíny" #: sphinx/themes/basic/genindex-single.html:35 #, python-format msgid "Index – %(key)s" -msgstr "Index – %(key)s" +msgstr "Rejstřík – %(key)s" #: sphinx/themes/basic/genindex-single.html:63 #: sphinx/themes/basic/genindex-split.html:24 #: sphinx/themes/basic/genindex-split.html:38 #: sphinx/themes/basic/genindex.html:74 msgid "Full index on one page" -msgstr "Plný index na jedné stránce" +msgstr "Celý rejstřík na jedné stránce" #: sphinx/themes/basic/genindex-split.html:16 msgid "Index pages by letter" -msgstr "Index podle písmene" +msgstr "Rejstřík podle písmene" #: sphinx/themes/basic/genindex-split.html:25 msgid "can be huge" @@ -644,7 +644,7 @@ msgstr "Navigace" #: sphinx/themes/basic/layout.html:122 #, python-format msgid "Search within %(docstitle)s" -msgstr "Hledání uvnitř %(docstitle)s" +msgstr "Prohledat %(docstitle)s" #: sphinx/themes/basic/layout.html:131 msgid "About these documents" @@ -701,7 +701,7 @@ msgstr "další kapitola" msgid "" "Please activate JavaScript to enable the search\n" " functionality." -msgstr "" +msgstr "Pro podporu vyhledávání aktivujte JavaScript." #: sphinx/themes/basic/search.html:32 msgid "" @@ -709,18 +709,18 @@ msgid "" " words into the box below and click \"search\". Note that the search\n" " function will automatically search for all of the words. Pages\n" " containing fewer words won't appear in the result list." -msgstr "Toto je vyhledávací stránka. Zadejte klíčová slova a klikněte na \"hledej\". \nVyhledávání hledá automaticky všechna slova. Nebudou tedy nalezeny stránky, obsahující méně slov." +msgstr "Toto je vyhledávací stránka. Zadejte klíčová slova a klikněte na \"hledat\". \nVyhledávání automaticky hledá všechna slova, nebudou tedy nalezeny stránky obsahující jen některé z nich." #: sphinx/themes/basic/search.html:39 #: sphinx/themes/basic/searchresults.html:17 msgid "search" -msgstr "hledej" +msgstr "hledat" #: sphinx/themes/basic/search.html:43 #: sphinx/themes/basic/searchresults.html:21 #: sphinx/themes/basic/static/searchtools.js_t:281 msgid "Search Results" -msgstr "Výsledky hledání" +msgstr "Výsledky vyhledávání" #: sphinx/themes/basic/search.html:45 #: sphinx/themes/basic/searchresults.html:23 @@ -728,7 +728,7 @@ msgstr "Výsledky hledání" msgid "" "Your search did not match any documents. Please make sure that all words are" " spelled correctly and that you've selected enough categories." -msgstr "" +msgstr "Vyhledávání nenalezlo žádný odpovídající dokument. Ujistěte se, že jste všechna slova zapsal/a správně a že jste vybral/a dostatek kategorií." #: sphinx/themes/basic/searchbox.html:12 msgid "Quick search" @@ -781,33 +781,33 @@ msgstr "Skrýt výsledky vyhledávání" #: sphinx/themes/basic/static/searchtools.js_t:119 msgid "Searching" -msgstr "" +msgstr "Probíhá vyhledání" #: sphinx/themes/basic/static/searchtools.js_t:124 msgid "Preparing search..." -msgstr "" +msgstr "Vyhledávání se připravuje..." #: sphinx/themes/basic/static/searchtools.js_t:285 #, python-format msgid "Search finished, found %s page(s) matching the search query." -msgstr "" +msgstr "Vyhledávání dokončeno, stránky odpovídající hledanému výrazu: %s." #: sphinx/themes/basic/static/searchtools.js_t:337 msgid ", in " -msgstr "" +msgstr ", v " #: sphinx/themes/default/static/sidebar.js_t:83 msgid "Expand sidebar" -msgstr "" +msgstr "Rozbalit boční lištu" #: sphinx/themes/default/static/sidebar.js_t:96 #: sphinx/themes/default/static/sidebar.js_t:124 msgid "Collapse sidebar" -msgstr "" +msgstr "Sbalit boční lištu" #: sphinx/themes/haiku/layout.html:26 msgid "Contents" -msgstr "" +msgstr "Obsah" #: sphinx/writers/latex.py:189 msgid "Release" @@ -816,20 +816,20 @@ msgstr "Vydání" #: sphinx/writers/latex.py:620 sphinx/writers/manpage.py:181 #: sphinx/writers/texinfo.py:612 msgid "Footnotes" -msgstr "" +msgstr "Poznámky pod čarou" #: sphinx/writers/latex.py:704 msgid "continued from previous page" -msgstr "" +msgstr "pokračujte na předchozí stránce" #: sphinx/writers/latex.py:710 msgid "Continued on next page" -msgstr "" +msgstr "Pokračujte na další stránce" #: sphinx/writers/manpage.py:226 sphinx/writers/text.py:541 #, python-format msgid "[image: %s]" -msgstr "" +msgstr "[obrázek: %s]" #: sphinx/writers/manpage.py:227 sphinx/writers/text.py:542 msgid "[image]" diff --git a/sphinx/locale/ja/LC_MESSAGES/sphinx.mo b/sphinx/locale/ja/LC_MESSAGES/sphinx.mo index 67e2656f6..82b838b04 100644 Binary files a/sphinx/locale/ja/LC_MESSAGES/sphinx.mo and b/sphinx/locale/ja/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/ja/LC_MESSAGES/sphinx.po b/sphinx/locale/ja/LC_MESSAGES/sphinx.po index a6fbb348b..7906d68be 100644 --- a/sphinx/locale/ja/LC_MESSAGES/sphinx.po +++ b/sphinx/locale/ja/LC_MESSAGES/sphinx.po @@ -3,7 +3,7 @@ # This file is distributed under the same license as the Sphinx project. # # Translators: -# しろう, 2013 +# shirou - しろう, 2013 # Akitoshi Ohta , 2011 # Kouhei Sutou , 2011 # Takayuki Shimizukawa , 2013 @@ -13,7 +13,7 @@ msgstr "" "Project-Id-Version: Sphinx\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" "POT-Creation-Date: 2013-04-02 10:33+0200\n" -"PO-Revision-Date: 2013-08-05 23:51+0000\n" +"PO-Revision-Date: 2013-11-20 09:59+0000\n" "Last-Translator: Takayuki Shimizukawa \n" "Language-Team: Japanese (http://www.transifex.com/projects/p/sphinx-1/language/ja/)\n" "MIME-Version: 1.0\n" diff --git a/utils/release-checklist b/utils/release-checklist index 8ea08bdee..ab234f3ea 100644 --- a/utils/release-checklist +++ b/utils/release-checklist @@ -7,7 +7,9 @@ Release checklist * Update release date in CHANGES * hg commit * make clean -* python setup.py release bdist_egg sdist upload +* python setup.py release bdist_wheel sdist upload +* For all other versions: pythonX.Y setup.py release bdist_wheel upload + (remove build/ before each one) * Check PyPI release page for obvious errors * hg tag * Merge default into stable if final major release