diff --git a/CHANGES b/CHANGES index 6e7d59343..4171e45b7 100644 --- a/CHANGES +++ b/CHANGES @@ -100,6 +100,8 @@ New features added Release 0.5.2 (in development) ============================== +* #86: Fix explicit document titles in toctrees. + * #81: Write environment and search index in a manner that is safe from exceptions that occur during dumping. diff --git a/EXAMPLES b/EXAMPLES index d3ac299c4..e81947a33 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -36,9 +36,11 @@ included, please mail to `the Google group * Pylons: http://docs.pylonshq.com/ * Pysparse: http://pysparse.sourceforge.net/ * Python: http://docs.python.org/dev/ +* Reteisi: http://docs.argolinux.org/reteisi/ * Satchmo: http://www.satchmoproject.com/docs/svn/ * Sphinx: http://sphinx.pocoo.org/ * SQLAlchemy: http://www.sqlalchemy.org/docs/ +* Sqlkit: http://sqlkit.argolinux.org/ * SymPy: http://docs.sympy.org/ * tinyTiM: http://tinytim.sourceforge.net/docs/2.0/ * TurboGears: http://turbogears.org/2.0/docs/ diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 11ea4ab40..ccaf7ca8c 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -12,6 +12,13 @@ This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way. +.. note:: + + For Sphinx (actually, the Python interpreter that executes Sphinx) to find + your module, it must be importable. That means that the module or the + package must be in one of the directories on :data:`sys.path` -- adapt your + :data:`sys.path` in the configuration file accordingly. + For this to work, the docstrings must of course be written in correct reStructuredText. You can then use all of the usual Sphinx markup in the docstrings, and it will end up correctly in the documentation. Together with diff --git a/sphinx/environment.py b/sphinx/environment.py index 57aef6746..08431c283 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -1004,12 +1004,12 @@ class BuildEnvironment: # replace titles, if needed, and set the target paths in the # toctrees (they are not known at TOC generation time) for refnode in newnode.traverse(nodes.reference): - refnode['refuri'] = builder.get_relative_uri( - docname, refnode['refuri']) + refnode['anchorname'] if titleoverrides and not refnode['anchorname'] \ and refnode['refuri'] in titleoverrides: newtitle = titleoverrides[refnode['refuri']] refnode.children = [nodes.Text(newtitle)] + refnode['refuri'] = builder.get_relative_uri( + docname, refnode['refuri']) + refnode['anchorname'] return newnode descroles = frozenset(('data', 'exc', 'func', 'class', 'const', diff --git a/sphinx/locale/cs/LC_MESSAGES/sphinx.js b/sphinx/locale/cs/LC_MESSAGES/sphinx.js index 0684899da..42fa9abdd 100644 --- a/sphinx/locale/cs/LC_MESSAGES/sphinx.js +++ b/sphinx/locale/cs/LC_MESSAGES/sphinx.js @@ -1 +1 @@ -Documentation.addTranslations({"locale": "cs", "plural_expr": "(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)", "messages": {"module, in ": "modul, v", "Preparing search...": "Připravuji hledání...", "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "Nenalezli jsme žádný dokument. Ujistěte se prosím, že všechna slova jsou správně.", "Search finished, found %s page(s) matching the search query.": "Vyhledávání skončilo, nalezeno %s stran.", ", in ": ", v", "Permalink to this headline": "Trvalý odkaz na tento nadpis", "Searching": "Hledám", "Permalink to this definition": "Trvalý odkaz na tuto definici", "Hide Search Matches": "Skrýt výsledky hledání", "Search Results": "Výsledky hledání"}}); +Documentation.addTranslations({"locale": "cs", "plural_expr": "(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)", "messages": {"module, in ": "modul, v", "Preparing search...": "P\u0159ipravuji vyhled\u00e1v\u00e1n\u00ed....", "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "Nenalezli jsme \u017e\u00e1dn\u00fd dokument. Ujist\u011bte se pros\u00edm, \u017ee v\u0161echna slova jsou spr\u00e1vn\u011b a \u017ee jste vybral dostatek kategori\u00ed.", "Search finished, found %s page(s) matching the search query.": "Vyhled\u00e1v\u00e1n\u00ed skon\u010dilo, nalezeno %s stran.", ", in ": ", v", "Permalink to this headline": "Trval\u00fd odkaz na tento nadpis", "Searching": "Hled\u00e1m", "Permalink to this definition": "Trval\u00fd odkaz na tuto definici", "Hide Search Matches": "Skr\u00fdt v\u00fdsledky vyhled\u00e1v\u00e1n\u00ed", "Search Results": "V\u00fdsledky hled\u00e1n\u00ed"}}); \ No newline at end of file diff --git a/sphinx/locale/cs/LC_MESSAGES/sphinx.mo b/sphinx/locale/cs/LC_MESSAGES/sphinx.mo index fd97a57e9..9178448d8 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/de/LC_MESSAGES/sphinx.mo b/sphinx/locale/de/LC_MESSAGES/sphinx.mo index 462f7c7f2..981da26a5 100644 Binary files a/sphinx/locale/de/LC_MESSAGES/sphinx.mo and b/sphinx/locale/de/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/es/LC_MESSAGES/sphinx.mo b/sphinx/locale/es/LC_MESSAGES/sphinx.mo index d1ddb0795..dcc8bbc2d 100644 Binary files a/sphinx/locale/es/LC_MESSAGES/sphinx.mo and b/sphinx/locale/es/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/fr/LC_MESSAGES/sphinx.mo b/sphinx/locale/fr/LC_MESSAGES/sphinx.mo index 158e964ac..326332964 100644 Binary files a/sphinx/locale/fr/LC_MESSAGES/sphinx.mo and b/sphinx/locale/fr/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/it/LC_MESSAGES/sphinx.js b/sphinx/locale/it/LC_MESSAGES/sphinx.js index c2c8be7bf..91a939a6d 100644 --- a/sphinx/locale/it/LC_MESSAGES/sphinx.js +++ b/sphinx/locale/it/LC_MESSAGES/sphinx.js @@ -1 +1 @@ -Documentation.addTranslations({"locale": "it", "plural_expr": "(n != 1)", "messages": {"module, in ": "modulo, in", "Preparing search...": "Preparazione della ricerca", "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "La tua ricerca non ha trovato alcun risultato. Controlla la corettezzadei termini di ricerca e di avere selezionato un numero sufficiente di categorie", "Search finished, found %s page(s) matching the search query.": "Ricera terminata, trovate %s pagine corrispondenti alla ricerca.", ", in ": ", in ", "Permalink to this headline": "link permanente per questa inestazione", "Searching": "Ricerca in corso", "Permalink to this definition": "link permanente per questa definizione", "Hide Search Matches": "Nascondi i risultati della ricerca", "Search Results": "Risultati della ricerca"}}); \ No newline at end of file +Documentation.addTranslations({"locale": "it", "plural_expr": "(n != 1)", "messages": {"module, in ": "modulo, in", "Preparing search...": "Preparazione della ricerca", "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.": "La tua ricerca non ha trovato alcun risultato. Controlla la correttezza dei termini di ricerca e di avere selezionato un numero sufficiente di categorie", "Search finished, found %s page(s) matching the search query.": "Ricerca terminata, trovate %s pagine corrispondenti alla ricerca.", ", in ": ", in ", "Permalink to this headline": "link permanente per questa intestazione", "Searching": "Ricerca in corso", "Permalink to this definition": "link permanente per questa definizione", "Hide Search Matches": "Nascondi i risultati della ricerca", "Search Results": "Risultati della ricerca"}}); \ No newline at end of file diff --git a/sphinx/locale/it/LC_MESSAGES/sphinx.mo b/sphinx/locale/it/LC_MESSAGES/sphinx.mo index 7818e8767..3aa570de0 100644 Binary files a/sphinx/locale/it/LC_MESSAGES/sphinx.mo and b/sphinx/locale/it/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/it/LC_MESSAGES/sphinx.po b/sphinx/locale/it/LC_MESSAGES/sphinx.po index 4545f4a8a..73c88e2bd 100644 --- a/sphinx/locale/it/LC_MESSAGES/sphinx.po +++ b/sphinx/locale/it/LC_MESSAGES/sphinx.po @@ -2,19 +2,19 @@ # Copyright (C) 2008 ORGANIZATION # This file is distributed under the same license as the Sphinx project. # Sandro Dentella , 2008. -# msgid "" msgstr "" "Project-Id-Version: Sphinx 0.5\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" "POT-Creation-Date: 2008-11-27 18:39+0100\n" -"PO-Revision-Date: 2008-12-28 23:40+0100\n" -"Last-Translator: FULL NAME \n" -"Language-Team: it \n" -"Plural-Forms: nplurals=2; plural=(n != 1)\n" +"PO-Revision-Date: 2009-01-06 17:38+0200\n" +"Last-Translator: Sandro Dentella \n" +"Language-Team: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1)\n" +"X-Generator: Virtaal 0.2\n" "Generated-By: Babel 0.9.3\n" #: sphinx/environment.py:103 sphinx/writers/latex.py:170 @@ -41,7 +41,7 @@ msgstr "Cerca" #: sphinx/roles.py:53 sphinx/directives/desc.py:564 #, python-format msgid "environment variable; %s" -msgstr "variabile dámbiente, %s" +msgstr "variabile d'ambiente, %s" #: sphinx/roles.py:60 #, python-format @@ -155,7 +155,7 @@ msgstr "%s (%s attributo)" #: sphinx/directives/desc.py:74 #, python-format msgid "%s (C function)" -msgstr "%s (functione C)" +msgstr "%s (funzione C)" #: sphinx/directives/desc.py:76 #, python-format @@ -194,7 +194,6 @@ msgid "Return type" msgstr "Tipo di ritorno" #: sphinx/directives/desc.py:201 -#, fuzzy msgid "Parameter" msgstr "Parametri" @@ -235,7 +234,7 @@ msgstr "Vedi anche" #: sphinx/ext/autodoc.py:576 sphinx/ext/autodoc.py:590 #, python-format msgid "alias of :class:`%s`" -msgstr "" +msgstr "alias per :class:`%s`" #: sphinx/ext/todo.py:31 msgid "Todo" @@ -335,7 +334,7 @@ msgstr "funzione built-in" #: sphinx/static/doctools.js:139 sphinx/writers/html.py:415 msgid "Permalink to this headline" -msgstr "link permanente per questa inestazione" +msgstr "link permanente per questa intestazione" #: sphinx/static/doctools.js:145 sphinx/writers/html.py:80 msgid "Permalink to this definition" @@ -370,14 +369,13 @@ 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 "" -"La tua ricerca non ha trovato alcun risultato. Controlla la corettezzadei" -" termini di ricerca e di avere selezionato un numero sufficiente di " -"categorie" +"La tua ricerca non ha trovato alcun risultato. Controlla la correttezza dei " +"termini di ricerca e di avere selezionato un numero sufficiente di categorie" #: sphinx/static/searchtools.js:457 #, python-format msgid "Search finished, found %s page(s) matching the search query." -msgstr "Ricera terminata, trovate %s pagine corrispondenti alla ricerca." +msgstr "Ricerca terminata, trovate %s pagine corrispondenti alla ricerca." #: sphinx/templates/defindex.html:2 msgid "Overview" @@ -432,7 +430,7 @@ msgstr "Navigazione" #: sphinx/templates/layout.html:40 msgid "Table Of Contents" -msgstr "Tablella dei contenuti" +msgstr "Tabella dei contenuti" #: sphinx/templates/layout.html:46 msgid "Previous topic" @@ -467,9 +465,8 @@ msgid "Go" msgstr "Vai" #: sphinx/templates/layout.html:73 -#, fuzzy msgid "Enter search terms or a module, class or function name." -msgstr "Inserisci un modulo, classe o nome di funzione" +msgstr "Inserisci un termine di ricerca un modulo, classe o nome di funzione" #: sphinx/templates/layout.html:106 #, python-format @@ -529,10 +526,8 @@ msgid "" " function will automatically search for all of the words. Pages\n" " containing fewer words won't appear in the result list." msgstr "" -"Puoi effettuare una ricerca in questi documenti. Immetti le parole chiave" -" \n" -" della tua ricerca nel riquadro sottostante \"search\". Nota che la " -"funzione\n" +"Puoi effettuare una ricerca in questi documenti. Immetti le parole chiave \n" +" della tua ricerca nel riquadro sottostante \"cerca\". Nota che la funzione\n" " di ricerca cerca automaticamente per tutte le parole. Le pagine\n" " che contendono meno parole non compariranno nei risultati di ricerca." @@ -562,18 +557,17 @@ msgstr "Lista delle modifiche generata automaticamente nella versione %(version) #: sphinx/templates/changes/versionchanges.html:18 msgid "Library changes" -msgstr "Modifiche nela libreria" +msgstr "Modifiche nella libreria" #: sphinx/templates/changes/versionchanges.html:23 msgid "C API changes" -msgstr "Modifche nelle API C" +msgstr "Modifiche nelle API C" #: sphinx/templates/changes/versionchanges.html:25 msgid "Other changes" msgstr "Altre modifiche" #: sphinx/writers/latex.py:173 -#, fuzzy msgid "Release" msgstr "Release" @@ -609,4 +603,3 @@ msgstr "[immagine]" #~ "non più valido. Abbiamo provato a " #~ "ridirigerti verso il nuovo indirizzo, ma" #~ " potrebbe non essere quello giusto" - diff --git a/sphinx/locale/ja/LC_MESSAGES/sphinx.mo b/sphinx/locale/ja/LC_MESSAGES/sphinx.mo index 66b1aa9db..85f6f8cc4 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/nl/LC_MESSAGES/sphinx.mo b/sphinx/locale/nl/LC_MESSAGES/sphinx.mo index 583a29933..2b6ac75ee 100644 Binary files a/sphinx/locale/nl/LC_MESSAGES/sphinx.mo and b/sphinx/locale/nl/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/pl/LC_MESSAGES/sphinx.mo b/sphinx/locale/pl/LC_MESSAGES/sphinx.mo index ec1f36026..b08244bff 100644 Binary files a/sphinx/locale/pl/LC_MESSAGES/sphinx.mo and b/sphinx/locale/pl/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo b/sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo index 647d44053..3044318ac 100644 Binary files a/sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo and b/sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/sl/LC_MESSAGES/sphinx.mo b/sphinx/locale/sl/LC_MESSAGES/sphinx.mo index d5282768a..e0936704e 100644 Binary files a/sphinx/locale/sl/LC_MESSAGES/sphinx.mo and b/sphinx/locale/sl/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo b/sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo index 4412f12f1..bd4acf006 100644 Binary files a/sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo and b/sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo differ diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py index 73def0dcf..9149b1112 100644 --- a/sphinx/quickstart.py +++ b/sphinx/quickstart.py @@ -38,9 +38,9 @@ QUICKSTART_CONF = '''\ import sys, os -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. +# If your extensions (or modules documented by autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.append(os.path.abspath('.')) # -- General configuration ----------------------------------------------------- diff --git a/sphinx/themes/default/static/default.css b/sphinx/themes/default/static/default.css index 2ea551764..40b1f1520 100644 --- a/sphinx/themes/default/static/default.css +++ b/sphinx/themes/default/static/default.css @@ -184,6 +184,7 @@ pre { padding: 5px; background-color: #efc; color: #333; + line-height: 120%; border: 1px solid #ac9; border-left: none; border-right: none;