Commit Graph

4274 Commits

Author SHA1 Message Date
Nozomu Kaneko
81d21a7714 make versionmodified translatable 2013-02-04 09:03:34 +09:00
Nozomu Kaneko
6aa8d4b373 Merged in knzm/sphinx-fix-docfields-fork (pull request #96) 2013-02-04 05:59:15 +09:00
Takayuki Shimizukawa
70f3f889d1 Fix autodoc crash if :members: and :special-members: ware both set (by d7ac5e4). 2013-02-03 22:27:20 +09:00
Takayuki Shimizukawa
e70a43a9c5 Closes #1062: sphinx.ext.autodoc use __init__ method signature for class signature. 2013-02-03 20:27:34 +09:00
Takayuki Shimizukawa
4d4dad3610 test refactoring: use with_setup for all test_autodoc.py's tests 2013-02-03 13:53:10 +09:00
Takayuki Shimizukawa
e47f434c32 add test for pull request #111: Respect add_autodoc_attrgetter() even when inherited-members is set 2013-02-03 12:48:39 +09:00
A. Jesse Jiryu Davis
6945551c20 Respect add_autodoc_attrgetter() even when inherited-members is set 2013-01-31 12:22:11 -05:00
Takayuki Shimizukawa
a86ea846e2 Fix :term: doesn't link to glossary if term text translated. refs #1090 2013-01-30 23:41:37 +09:00
Takayuki Shimizukawa
9735ec0a74 fix source and line value for glossary term. refs #1090 2013-01-30 00:49:41 +09:00
Takayuki Shimizukawa
6f4764f77b Fix gettext does not extract glossary terms. Closes #1090 2013-01-30 00:13:58 +09:00
Johannes Dewender
ffb825d733 fix tests for autodoc novalue option
In the tests for autodoc the Options are of type struct,
while in the code there is a special autodoc.Options class,
which is a dict.

So "novalue" in self.options doesn't work,
but self.options.novalue does work for both.

Additionally the logic for autoattribute was wrong and is fixed now.
2013-01-24 18:17:53 +01:00
Johannes Dewender
391f99d13a autodoc: document novalue option
The update is listed for version 1.2.
This should be changed if the change is released later.
2013-01-22 17:58:47 +01:00
Johannes Dewender
6b9f35455d autodoc: novalue option for autodata and autoattribute
This adds a ":novalue:" option to "autodata" and "autoattribute"
from the autodoc extension.
When the option is set, no value will be in the output.
2013-01-22 17:58:45 +01:00
Takayuki Shimizukawa
de1f19da36 fix debug2 UnicodeEncodeError issue caused by docutils Element.__repr__() return unicode object if Element['names'] contain unicode object.
This is maybe docutils issue: https://sourceforge.net/tracker/?func=detail&aid=3601607&group_id=38414&atid=422030
2013-01-21 03:44:31 +00:00
Takayuki Shimizukawa
60f6fc4805 fix debug2 UnicodeEncodeError issue with multibyte names node 2013-01-21 08:09:43 +09:00
Takayuki Shimizukawa
fbd63617cf add installations for each environments 2013-01-20 16:06:04 +09:00
Georg Brandl
b8aba34add merge default heads 2013-01-19 21:15:11 +01:00
Georg Brandl
158db97669 null merge with stable 2013-01-19 21:14:50 +01:00
Georg Brandl
926cd01168 Remove devguide mention. 2013-01-19 21:14:22 +01:00
Georg Brandl
20279b07a4 New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Georg Brandl
0939d6fcdb New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Takayuki Shimizukawa
a1bf7dbcf8 fix: output all html every time with python3.3.
Sphinx detect config changing by hash(str(cfgdict)).
In python3.3, str(dict_instance) retun another string per process.
2013-01-15 14:16:16 +09:00
Takayuki Shimizukawa
6e4a36d2fe fix: import xml confusing. 2to3 converted import xml.etree.... into from . import ... 2013-01-14 16:56:26 +09:00
Georg Brandl
59dc803aba builders: the text and xml builders can be parallelized too 2013-01-14 08:41:41 +01:00
Georg Brandl
c59cb9d6f6 docs: document -j option and add changelog 2013-01-14 08:38:46 +01:00
Georg Brandl
3889a1158f builder: reduce # of subprocesses to N-1 for -jN, since the main process is also busy now 2013-01-14 08:35:41 +01:00
Georg Brandl
2b06c656c1 faq: add sphinx-contrib 2013-01-14 00:07:19 +01:00
Georg Brandl
0701c850d2 faq: add Hieroglyph 2013-01-14 00:02:51 +01:00
Georg Brandl
b8967b4ee8 tutorial: make "documentation collection" clearer 2013-01-14 00:01:18 +01:00
Georg Brandl
5cd0841e5f builder: fix parallel build globals problems by splitting write_doc in two
stages: write_doc() and write_doc_serialized(), the latter of which is not
called in the parallel processes.

This costs speedup, of course: from about 50% we are down to about 30%
improvement on my 4-core machine.
2013-01-13 19:46:34 +01:00
Georg Brandl
83c6b8231e Set "allow_parallel" to false by default. 2013-01-13 19:44:09 +01:00
Georg Brandl
53d1d79ff8 builder: implement parallel writing based on multiprocessing
Does not work completely yet: globals such as the search index and
images for HTML are not updated properly: this needs a new API.
2013-01-13 17:27:09 +01:00
Georg Brandl
2e4608039c builder: make the status_iterator more flexible by supplying a function
used to stringify the current item for display
2013-01-13 17:25:34 +01:00
Georg Brandl
c88ba504f3 Introduce a "-j" flag for parallel build. 2013-01-13 14:15:45 +01:00
Georg Brandl
b831acf617 Refactor the "usage" help text into several sections. 2013-01-13 14:12:33 +01:00
Georg Brandl
95c45a0ab3 autodoc: debug module analyzer failure 2013-01-13 14:05:40 +01:00
Georg Brandl
9b4efc9ba3 Fix pyflakes issues. 2013-01-13 10:26:52 +01:00
Georg Brandl
7d68f0e4a2 Fix long lines reported by "make check". 2013-01-13 10:22:38 +01:00
Georg Brandl
1bf5a17534 Closes #1076: document new sphinx-build options. 2013-01-12 22:45:47 +01:00
Nozomu Kaneko
58c0c79c17 use `nodes.inline` with a "translatable" attr instead 2013-01-13 02:14:00 +09:00
Takayuki Shimizukawa
3a5277c14c fix: autodoc documented descriptor class as attribute 2013-01-12 18:12:55 +09:00
Takayuki Shimizukawa
f363ef400e figure-caption work-around set int or None to node.line instead of empty string. 2013-01-12 22:30:40 +09:00
Takayuki Shimizukawa
9f8f93e5e1 fix test_seealso failed with python3 2013-01-12 22:26:38 +09:00
Georg Brandl
7d2715ab17 autodoc: use debug2() and [autodoc] prefix 2013-01-12 12:43:00 +01:00
Georg Brandl
72132ffebd Verbosity: add another "debug2" function for level 3, use it for event debugging. Prefix debug messages with component name. 2013-01-12 12:35:04 +01:00
Georg Brandl
f022886032 Write "making output directory" to the status fd, not to stderr unconditionally. 2013-01-12 12:22:30 +01:00
Georg Brandl
c1176a1bdb Write verbose/debug messages to status fd, not warning fd. 2013-01-12 12:22:13 +01:00
Georg Brandl
7089bd5ff6 Add a link to the Sphinx homepage when sphinx-build is called with -h. 2013-01-12 12:18:56 +01:00
Jonathan Waltman
4eead33488 Fix local search which was broken by correcting JS issues found by JSHint (commit 46d08152a30d) 2013-01-10 21:58:18 -06:00
Jonathan Waltman
e26b02e23e Closes #1070: Avoid un-pickling issues under Python 3 when accessing doctrees saved under Python 2. 2013-01-09 08:58:28 -06:00