Commit Graph

991 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
46cd97873c Fix C++ tests. 2015-02-08 23:22:31 +01:00
Georg Brandl
bf3bdcc7f5 source_suffix can now be a list. 2015-02-08 20:13:47 +01:00
Ian Lee
9302231342 Added insertion of todo_include_todos config option.
Set to True when we enable 'ext_todo' during the quickstart process.
2015-02-07 00:00:08 -08:00
Jakob Lykke Andersen
d09bcfa717 C++, minor code formatting fixes. 2015-02-07 01:26:35 +01:00
Jakob Lykke Andersen
d8a109976b Merge from master 2015-02-07 00:55:19 +01:00
Jakob Lykke Andersen
fb3a524a90 C++, fixes to id generation.
New ids are prefixed with "_CPPv1". Replacing the prefix with "_Z"
should yield a valid mangled name following the Itanium C++ ABI,
except for expressions, which are currently not handled.
2015-02-06 08:35:12 +01:00
Jakob Lykke Andersen
f4cf30b95e C++, old-style linkes, const/volatile and templates, sphinx-doc/sphinx#1704 2015-02-05 10:00:50 +01:00
Jakob Lykke Andersen
89c919911f Merge from master 2015-02-04 23:23:28 +01:00
Jakob Lykke Andersen
aaa71b0606 Towards a solution for sphinx-doc/sphinx#1704.
Elements now get multiple ids to keep permalinks permanent. The default
id is the newest style, which is used as the shown permalink and in the
index. The old style ids have been (partially) replicated and are
temporarily used as the default id for testing purposes.
2015-02-04 10:11:58 +01:00
Georg Brandl
3068f6c7f1 Merge pull request #1705 from jakobandersen/cpp-declspecs-on-right
C++, fix #1689
2015-02-04 06:37:13 +01:00
Jakob Lykke Andersen
5f0977ca30 C++, add support for 'const', 'volatile', etc. on the right-hand side of the type. 2015-02-03 09:18:18 +01:00
Georg Brandl
309e0169b0 Adapt test after env-updated change. 2015-01-25 16:25:32 +01:00
Takeshi KOMIYA
b563fa44f2 Fix #1620: Use VerbatimBorderColor to add frame to code-block in LaTeX 2015-01-18 15:32:17 +09:00
Alastair Houghton
cc58f0a5e4 Use binary mode for reading plist file, as per Python 3 docs. 2015-01-15 13:40:37 +00:00
Alastair Houghton
d2d202f160 Added tests for Apple Help generation. 2015-01-15 13:17:01 +00:00
Rob Ruana
9df7b53782 Closes #1670: Fix napoleon handling of *args and **kwargs parameters 2015-01-12 17:08:51 -05:00
Georg Brandl
0071ac8399 Test fixup. 2015-01-09 18:41:09 +01:00
Georg Brandl
81313e903b Merge pull request #1666 from EricFromCanada/highlight_options
Add highlight_options configuration value
2015-01-06 17:09:29 +01:00
EricFromCanada
5d96523f7d Fix LaTeX writer's handling of multirow table cells
Originally the LaTeX writer could only handle one multirow cell per
row. This commit fixes that and adds support for cells spanning both
rows and columns.
2015-01-06 02:06:58 -05:00
EricFromCanada
a63e4945ea Add highlight_options configuration value
This changeset adds the `highlight_options` configuration value, which
specifies a dict of key-value pairs to pass to the Pygments highlighter
specified with `highlight_language`. For example, specifying
`highlight_options = {'funcnamehighlighting' : False}` for the 'php'
lexer will disable function name highlighting.
Both the HTML and LaTeX writers have been updated to include the
options when calling `highlight_block()`, as long as the currently
selected language matches what was set with `highlight_language`, i.e.
not when modified by `highlight::` or `code-block::` directives.
2015-01-05 12:58:43 -05:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Jakob Lykke Andersen
c010b47589 C++, initial enum support (see #772) 2015-01-03 16:59:08 +01:00
Takayuki Shimizukawa
edf63e1406 Fix again. Sections which depth are lower than :tocdepth: should not be shown on localtoc sidebar. Closes #1251 2014-12-05 16:42:30 +09:00
Takayuki Shimizukawa
32e4fab86b fix py3 error for pull request #314 2014-12-04 17:26:13 +09:00
Takayuki Shimizukawa
c0a9d7740e Merged in lehmannro/sphinx-warnconfig (pull request #314)
Check configuration values for their types
2014-12-04 17:22:20 +09:00
tk0miya
0f1d8433e7 Fix #1607: Sphinx crashes on building latexpdf with "howto" class 2014-11-24 12:13:17 +09:00
Georg Brandl
4d5b20de38 merge with stable 2014-11-17 19:36:34 +01:00
Georg Brandl
571cae87a5 Closes #1372: use https URL for PEPs and RFCs 2014-11-17 19:33:59 +01:00
Georg Brandl
6c194ad56f Closes #1623: Return types specified with `:rtype:` are now turned into links if possible. 2014-11-12 11:32:21 +01:00
Robert Lehmann
c528b65292 Refactor tests. 2014-11-09 09:55:56 +01:00
Georg Brandl
4f4d8688d5 Py3 fix. 2014-11-07 15:19:36 +01:00
Georg Brandl
bbd315b82e merge with stable 2014-11-07 15:03:06 +01:00
Georg Brandl
fa09ec000f Fix :confval:autodoc_docstring_signature not working with signatures
in class docstrings.
2014-11-07 15:01:10 +01:00
Georg Brandl
5edd1fcad8 Announce used Python version when running tests. 2014-11-06 09:12:51 +01:00
Georg Brandl
e6fa449e85 Add a basic test for sphinx.apidoc. 2014-11-06 09:11:20 +01:00
Georg Brandl
db57e82afe Stop removing temporary test data after tests. 2014-11-06 09:10:32 +01:00
Robert Lehmann
ed5f77916f Spec out configuration type checks. 2014-11-05 14:33:30 +01:00
Robert Lehmann
5cc72ca52b Checked configuration values for their types. Fixes #1150. 2014-10-30 15:46:02 +01:00
tk0miya
88103c112a Fix #1603 :numref: doesn't work correctly when label contain underscore
If label contains underscore, the underscores are replaced with hyphens on normalization.
:numref: confuses the normalization with explicit notation.
This fix uses `target` variable insted of labelid to check the role is explicit or not.
2014-10-27 11:02:54 +09:00
Takayuki Shimizukawa
d289870f48 rename numfig_prefix to numfig_format. later is better for the purpose. 2014-10-10 00:19:17 +09:00
Takayuki Shimizukawa
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +09:00
Takayuki Shimizukawa
1ff5ffe1ed Merged in tk0miya/sphinx (pull request #307)
Add frame to code-block in LaTeX
2014-10-09 21:31:28 +09:00
Takayuki Shimizukawa
2826af738d Merged in tk0miya/sphinx (pull request #303)
Add :numref: role to refer figures, tables and code-blocks by its fignum
2014-10-09 19:45:50 +09:00
Takayuki Shimizukawa
ab91342bb1 fix testing for jQuery-1.11.1 2014-10-09 00:56:26 +09:00
tk0miya
f51b945d89 Add frame to code-block in LaTeX 2014-10-08 21:52:33 +09:00
Takayuki Shimizukawa
a7de6a2575 fix testing for ad7ce315a358 2014-10-07 23:12:16 +09:00
Jeppe Pihl
29af67f438 merge 2014-10-06 20:31:30 +02:00
tk0miya
cdc244428d Merge with default 2014-10-06 23:57:16 +09:00
Georg Brandl
65296334e0 test fix 2014-10-06 15:49:15 +02:00
Georg Brandl
105122be43 Fix up default labels for figures and listings. 2014-10-06 15:19:42 +02:00
Takayuki Shimizukawa
6c0b4f1933 Merged in tk0miya/sphinx (pull request #304)
numfig feature improvement
2014-10-06 21:45:25 +09:00
Jeppe Pihl
0b0cf82a75 fixed bugs, and extended unit test to catch them again if they reappear 2014-10-06 10:58:03 +02:00
Jeppe Pihl
a3745cfb5e merge 2014-10-06 10:35:33 +02:00
tk0miya
a5606976b6 Fix flake8 violations 2014-10-06 13:56:51 +09:00
Takayuki Shimizukawa
b6b6f8ad79 Fix test for previous change.
Fix. <caption> node should not include <paragraph> block element as a result of nested_parse.
2014-10-06 07:10:52 +09:00
tk0miya
777218580a Surround fignum and caption with <span> tag 2014-10-05 20:55:46 +09:00
tk0miya
a875e8f377 Set permanent links to every captions and titles 2014-10-05 16:27:38 +09:00
Jeppe Pihl
dc3d0b6ca1 added test .rst files 2014-10-04 17:49:37 +02:00
Jeppe Pihl
22c8382880 added tests for linenos, lineno-start, lineno-match 2014-10-04 17:48:55 +02:00
tk0miya
8270575a9c Update testcases for :numref: 2014-10-02 11:17:34 +09:00
Jeppe Pihl
bbfe4d3bb9 fixed issues with line numbering not being showed correctly. 2014-10-02 00:41:30 +02:00
Jeppe Pihl
de8f428528 #1583: Allow the line numbering of the directive literalinclude to match that of the included file, using a new `lineno-match` option. 2014-09-30 00:11:28 +02:00
tk0miya
7e59c5385e Merge with default 2014-09-28 21:56:20 +09:00
Takayuki Shimizukawa
9d1225a35b add :confval:gettext_enables to enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation. Closes #1344 2014-09-28 21:19:54 +09:00
tk0miya
16529c5604 Add options argument to Sphinx.add_latex_package() 2014-09-28 21:10:26 +09:00
Takayuki Shimizukawa
39c843106f fix testing on Windows. 2014-09-28 21:00:51 +09:00
Takayuki Shimizukawa
a75d863290 Merged in tk0miya/sphinx (pull request #298)
Add new API: Sphinx.add_latex_package()
2014-09-28 12:59:59 +09:00
tk0miya
0c5b460dc6 Separate numfig testcase from toctree's 2014-09-27 16:49:28 +09:00
tk0miya
c04ad2908e Add new API: Sphinx.add_latex_package()
Sphinx.add_latex_package() allows sphinx extensions to add latex packages.
It helps creating extensions for latex (for example, latex-theming)
2014-09-27 12:47:27 +09:00
tk0miya
7cd470f59a Assign fignum to tables and code-blocks 2014-09-27 00:47:44 +09:00
Takayuki Shimizukawa
7984f81a5e Merged in tk0miya/sphinx (pull request #292)
do nested_parse() :caption: of code-block directive
2014-09-26 20:29:38 +09:00
tk0miya
7c7a563426 Fix by review comment 2014-09-26 20:15:17 +09:00
tk0miya
cffec13355 Add testcases for numfig 2014-09-26 00:36:38 +09:00
Takayuki Shimizukawa
88540e9a3b workaround for testing: \xbb will be replaced with /xbb by replace(os.sep, '/') process on Windows environment. 2014-09-24 01:41:01 +09:00
tk0miya
3ad1f1c164 Merge with default 2014-09-24 00:43:47 +09:00
tk0miya
5f96826ffc Merge with default 2014-09-23 17:58:02 +09:00
Takayuki Shimizukawa
a820a73442 Merged in tk0miya/sphinx (pull request #291)
Fix cannot capture title of literal_block node by xref
2014-09-23 12:21:15 +09:00
Georg Brandl
7bbaa4c73f Test suite fixes after env.update() change. 2014-09-22 15:08:15 +02:00
Georg Brandl
e7ed7cd627 Rename env-read-docs to env-before-read-docs, add changelog entry and fixup tests. 2014-09-22 09:13:44 +02:00
Georg Brandl
3c5cda97d1 Merged in guillemNaN/sphinx (pull request #261)
Add env-read-docs event to allow modify docnames list before processing
2014-09-22 09:05:00 +02:00
Georg Brandl
cdaf4b0a52 remove a few unused imports 2014-09-21 20:28:37 +02:00
Georg Brandl
24d303706f Fixup windows newlines. 2014-09-21 20:23:24 +02:00
Guillem Barba
fe077ea18b Don't multiply docnames list size per each listener of env-read-docs
The env-read-docs listener function doesn't return the modified docnames list
but change the list received as parameter.
Updated the tests
2014-09-21 19:50:46 +02:00
Georg Brandl
c5cc2a8cf9 flush stdout after printing messages, might fix output ordering on drone.io 2014-09-21 19:01:03 +02:00
Georg Brandl
ac690b4b07 move new assertion helpers to util.py 2014-09-21 18:54:01 +02:00
Georg Brandl
fa91f19e55 Reimplement assert_in and assert_not_in, they are not in nose in Py2.6. 2014-09-21 18:48:21 +02:00
Georg Brandl
70cf797c10 fix incompatibility in doctree between gettext and the rest 2014-09-21 18:46:15 +02:00
Georg Brandl
b637f0a728 No need to insist on fresh builds with test_build_* 2014-09-21 18:41:08 +02:00
Georg Brandl
b335e03b02 Speed up test_theming using a minimal project. 2014-09-21 18:37:44 +02:00
Georg Brandl
2661c1060d Refactor/speed up test_build_gettext using generators 2014-09-21 18:36:27 +02:00
Georg Brandl
be72ed6dc7 Refactor/speed up test_intl by combining all tests with a certain builder into a generator. 2014-09-21 18:26:50 +02:00
Georg Brandl
a73ab32bc5 Split viewcode and linkcode tests out of main test root. 2014-09-21 17:34:16 +02:00
Georg Brandl
78af37370c mock is builtin in Py3. 2014-09-21 17:32:52 +02:00
Georg Brandl
d47a7587f9 Complete test suite overhaul.
* rename a few test modules to make the names more consistent

* do not copy/use Sphinx from build/ (unnecessary without 2to3)

* use a temporary dir for *all* test projects, the source tree
  will stay pristine that way  (default is tests/build)

* speed up tests by ~3x by splitting up test projects and avoiding
  rebuilds
2014-09-21 17:17:02 +02:00
Georg Brandl
e21d669089 Test suite adapted after :option: changes. 2014-09-20 20:54:23 +02:00
Georg Brandl
a555bda5eb Closes #1284: Program options documented with :rst:dir:option can now start with `+`. 2014-09-20 19:58:11 +02:00
Georg Brandl
2c396601bf Move env.temp_data content that might be used to resolve references to a new env.ref_context dictionary. 2014-09-20 19:15:41 +02:00
Georg Brandl
6c3789a353 Add tests for "any" role and default-role setting. Fix some minor bugs with "any". 2014-09-19 14:17:36 +02:00
tk0miya
d076452199 do nested_parse() :caption: of code-block directive 2014-09-19 12:04:25 +09:00
tk0miya
447c8c1d37 Wrap float environment on writing literal_block to latex 2014-09-19 11:08:07 +09:00
tk0miya
873efc5358 Fix #1512 env.record_dependency crashes on multibyte directories 2014-09-15 22:10:13 +09:00
Georg Brandl
90c7adba6d rename "literal.inc.orig", too easy to delete together with other merge backup files 2014-09-07 15:28:58 +02:00
Guillem Barba
24c5eb6e9c Add unit test for new env-read-docs event 2014-09-01 09:19:43 +02:00
Takayuki Shimizukawa
d11267b205 Merge with stable 2014-08-30 20:20:19 +09:00
Takayuki Shimizukawa
ad69dadd14 Now Sphinx exits with non-zero status code if builder status is not success. Closes #508. 2014-08-29 01:14:54 +09:00
Takayuki Shimizukawa
438f9fe3de make text generate wrong table when it has empty table cells. Closes #1544 2014-08-26 20:52:02 +09:00
Takayuki Shimizukawa
8f7936d75c * gettext does not extract nodes.line in a table or list. Closes #1477 2014-08-26 01:39:26 +09:00
tk0miya
b17320ee1e Fix cannot capture title of literal_block node by xref 2014-08-24 14:33:56 +09:00
Takayuki Shimizukawa
8536b4844e Merged in tk0miya/sphinx (pull request #266)
Rename :filename: option of code-block directive to :caption:
2014-08-24 11:02:36 +09:00
Takayuki Shimizukawa
799ae87ce0 fix fc1901d for py3, again. and add 2 assertions 2014-08-22 13:01:11 +09:00
Takayuki Shimizukawa
2987330a11 fix fc1901d for py3 2014-08-22 12:39:42 +09:00
Takayuki Shimizukawa
e8b870de0c :mod:~sphinx.ext.viewcode support imported function/class aliases. Closes #623 2014-08-22 11:38:56 +09:00
tk0miya
dd8a02d5e1 Fix #1381 :rfc: and :pep: roles support custom link text 2014-08-20 12:27:08 +09:00
tk0miya
95fc3ce888 Backed out changeset 177fce4ba59c 2014-08-20 12:21:18 +09:00
tk0miya
3c1067c038 Fix #1381 :rfc: and :pep: roles support custom link text 2014-08-20 12:19:12 +09:00
tk0miya
3c8bc8f5fd Merge upstream changes 2014-08-20 10:05:58 +09:00
Takayuki Shimizukawa
4be8071639 Merged in tk0miya/sphinx (pull request #269)
Fix #1476 replace <tt> tag by <code>
2014-08-20 06:45:18 +09:00
Takayuki Shimizukawa
f68c3b1caf Merged in tk0miya/sphinx (pull request #274)
Set its URL as a default title value if URL appears in toctree
2014-08-20 06:14:15 +09:00
tk0miya
7db168416b Set its URL as a default title value if URL appears in toctree 2014-08-20 01:00:29 +09:00
tk0miya
57cc7dfa05 Fix RuntimeError with numbered circular toctree 2014-08-19 10:44:09 +09:00
Takayuki Shimizukawa
60911efe05 Merge with tip 2014-08-18 23:20:42 +09:00
Takayuki Shimizukawa
4046c5f0e2 Merged in tk0miya/sphinx (pull request #268)
Fix numbering section does not work at singlehtml mode (adhoc)
2014-08-18 23:10:59 +09:00
tk0miya
14107fd5de Fix numbering section at singlehtml mode does not work for nested toctree 2014-08-18 22:06:30 +09:00
Shoji KUMAGAI
b71508d6fa Add theme contents for 'bizstyle' 2014-08-15 13:38:02 +09:00
Takayuki Shimizukawa
b8c2619858 Merged in r_rudi/sphinx (pull request #267)
add 'diff' parameter to literalinclude.
2014-08-13 13:17:47 +09:00
shirou
4e70d364ba add test and document about diff params in literalinclude. 2014-08-12 14:11:54 +09:00
tk0miya
0943375069 Fix #1476 replace <tt> tag by <code> 2014-08-12 12:12:10 +09:00
tk0miya
5725ee0e82 Fix numbering section does not work at singlehtml mode (adhoc) 2014-08-12 11:22:34 +09:00
Takayuki Shimizukawa
954869df26 merge with stable 2014-08-12 06:42:57 +09:00
Takayuki Shimizukawa
e984e381e8 * On Python3 environment, docutils.conf with 'source_link=true' in the general section cause type error. Closes #1531 2014-08-12 00:11:23 +09:00
tk0miya
3e1667290b Rename :filename: option of code-block directive to :caption: 2014-08-11 22:36:31 +09:00
Takayuki Shimizukawa
e5cb460d8b * update old XPath notation 2014-08-11 14:19:14 +09:00
Takayuki Shimizukawa
1d65d9cdc6 rename test files 2014-08-10 23:47:27 +09:00
Takayuki Shimizukawa
d39327d539 * for pull request #258: update CHANGES, add tests, add a document and refactoring. 2014-08-10 23:03:02 +09:00
Takayuki Shimizukawa
ed9de1c9e8 * provide _copy_to_temp option for TestApp() 2014-08-10 22:23:52 +09:00
Takayuki Shimizukawa
8dcd094a30 Merged in jakobla/sphinx (pull request #263)
Rewrite of C++ domain (also fixes #1013, #1103)
2014-08-10 20:02:37 +09:00
Jakob Lykke Andersen
e43fcfa1f4 C++, test now also work with Python 3. 2014-08-10 11:59:22 +02:00
Takayuki Shimizukawa
c3fdd2a9c3 * refactoring 2014-08-10 16:31:28 +09:00
Takayuki Shimizukawa
68949656b2 * for PR#264: update CHANGES, add tests, small refactoring. 2014-08-10 16:28:31 +09:00
Jakob Lykke Andersen
640dfc1951 Merged birkenfeld/sphinx into default 2014-08-06 18:54:23 +02:00
Jakob Lykke Andersen
14e6affa7d C++, update id generation to use name mangling 2014-08-06 17:41:51 +02:00
Takayuki Shimizukawa
3efd230a0e fix test caused by previious commit: 989c16e04371c 2014-08-05 01:54:56 +09:00
Takayuki Shimizukawa
f7399a261a Add app.set_translator() API to register or override a Docutils translator class like :confval:html_translator_class. 2014-08-05 00:18:54 +09:00
Takayuki Shimizukawa
6580b23b90 Merged in lennart0901/sphinx (pull request #260)
Encode underscore in citation labels for latex export
2014-08-03 17:43:40 +09:00
Takayuki Shimizukawa
eaed3ca9f1 Automatically compile `*.mo files from *.po` files. 2014-08-03 16:22:08 +09:00
Takayuki Shimizukawa
eb8dbf4631 Fix malformed po files in the test-intl directory 2014-08-03 14:34:40 +09:00
Takayuki Shimizukawa
da4c67e2a3 When specifying toctree :numbered: option and :tocdepth: metadata, sub section number that is larger depth than :tocdepth: is shrinked. Closes #1251. 2014-08-02 18:10:41 +09:00
Takayuki Shimizukawa
24280fd90d * refactoring: metadata (docinfo) type normalization and add test. 2014-08-02 16:39:07 +09:00
Lennart Fricke
7a9cc9f95b Escape underscore in citation labels for latex export 2014-07-31 08:55:29 +02:00