Commit Graph

12965 Commits

Author SHA1 Message Date
Timotheus Kampik
cc93ea9439 Merge pull request #6103 from nathanshammah/qutip-project
add QuTiP to projects using sphinx_rtd_theme
2019-02-25 20:54:39 +01:00
Nathan Shammah
c5dbe3c8f8 add QuTiP to projects using sphinx_rtd_theme 2019-02-26 00:07:31 +09:00
Takeshi KOMIYA
832c81a2ca Update CHANGES for PR #6091 2019-02-25 23:59:51 +09:00
Takeshi KOMIYA
e049f86b2d Merge pull request #6091 from remyabel/3620_defer_searchindex
#3620: Defer searchindex.js rather than loading it via ajax
2019-02-25 23:58:39 +09:00
Stephen Finucane
17596b5f3c docs: Remove unused imports
These were causing flake8 failures.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-25 11:03:59 +00:00
Timotheus Kampik
d5aa1c6ccc #36 add Google Search how-to to FAQ 2019-02-24 23:03:49 +01:00
Takeshi KOMIYA
fa63dfe0f7 Update CHANGES for PR #5508 2019-02-24 20:42:37 +09:00
Takeshi KOMIYA
2745f1e156 Merge pull request #5508 from jdknight/bugfix/allow-applying-linenos-with-post-transform
directive-code: do not force linenos value on run
2019-02-24 20:37:22 +09:00
Takeshi KOMIYA
cafc522f54 Merge pull request #6099 from tk0miya/5993_REQUESTS_CA_BUNDLE
docs: Add a tip about $REQUESTS_CA_BUNDLE
2019-02-24 20:32:11 +09:00
Takeshi KOMIYA
9548b06d02 docs: Add a tip about $REQUESTS_CA_BUNDLE 2019-02-24 20:03:21 +09:00
Takeshi KOMIYA
0dec09a065 Update warning messages for script_files 2019-02-24 19:43:27 +09:00
Takeshi KOMIYA
ce093636e9 Merge pull request #6098 from tk0miya/6096_figure_anchors
Fix #6096: html: Anchor links are not added to figures
2019-02-24 19:39:17 +09:00
Takeshi KOMIYA
524ac7ff0a Fix #6096: html: Anchor links are not added to figures 2019-02-24 19:29:12 +09:00
Takeshi KOMIYA
35f4edb8fc Merge pull request #6093 from tk0miya/6088_better_warning_for_script_files
Update warning messages for script_files
2019-02-24 17:22:02 +09:00
Takeshi KOMIYA
d9d5594c6f Ignore filenames without file extension given to `Builder.build_specific()`
So far, ``Builder.build_specific()`` accpets filnames without file
extension. On the other hand, ``sphinx-build`` command does not accept
such files. So the special handling code is only working for 3rd party
applications. The behavior is not consistent. In addition, that is not
helpful for users.
This removes such behavior from builders. This does not change Sphinx
application itself. It only effects to the applications which uses the
API directly.
2019-02-23 21:13:09 +09:00
Takeshi KOMIYA
77cd1de79f Update warning messages for script_files 2019-02-22 13:20:00 +09:00
Tommy Nguyen
55c5168f33 #3620: Defer searchindex.js rather than loading it via ajax 2019-02-21 20:11:24 -05:00
Takeshi KOMIYA
ac4ec47378 Add testcase for specific build 2019-02-20 12:32:17 +09:00
Stephen Finucane
a35040c454 docs: Address further review comments
todo:
- Subclass SphinxDirective instead of Directive

recipe:
- Remove unnecessary '__init__' methods

Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-18 13:46:30 +00:00
Takeshi KOMIYA
12c614911a Bump version 2019-02-18 01:57:55 +09:00
Takeshi KOMIYA
0b2210c99a Bump version 2019-02-18 01:56:26 +09:00
Takeshi KOMIYA
60a1016aa4 Bump to 2.0.0 beta1 v2.0.0b1 2019-02-18 01:53:35 +09:00
Takeshi KOMIYA
d4ace4cd63 Fix wrong indentation 2019-02-17 22:43:58 +09:00
Takeshi KOMIYA
fa022fa377 Merge pull request #6086 from tk0miya/separate_serializinghtml
Separate json and pickle to sphinxcontrib package
2019-02-17 22:40:12 +09:00
Takeshi KOMIYA
8a391d1781 Merge branch '1.8' 2019-02-17 22:37:23 +09:00
Takeshi KOMIYA
1437dff4e1 Merge pull request #6042 from tk0miya/simplify_conf.py_html
quickstart: Simplify generated conf.py (HTML)
2019-02-17 22:32:59 +09:00
Takeshi KOMIYA
1ca210aab1 Separate json and pickle to sphinxcontrib package 2019-02-17 22:31:50 +09:00
Takeshi KOMIYA
527e955405 Merge pull request #6085 from tk0miya/refactor_tests_unpickle
test: Use get_doctree() to load doctree files
2019-02-17 20:58:32 +09:00
Takeshi KOMIYA
90bf81bd37 test: Use get_doctree() to load doctree files 2019-02-17 20:27:48 +09:00
Takeshi KOMIYA
836d65f04c Merge pull request #6083 from tk0miya/6047_autofunction_warns_for_methods
Fix #6047: autodoc: ``autofunction`` emits a warning for method objects
2019-02-17 19:17:07 +09:00
Takeshi KOMIYA
fcb22f2074 Merge pull request #5832 from stephenfin/bindep-integration
Add bindep integration
2019-02-17 18:25:26 +09:00
Takeshi KOMIYA
08cd23a0bb Fix #6047: autodoc: `autofunction` emits a warning for method objects 2019-02-17 18:23:14 +09:00
James Knight
3858a62814 test: verify linenothreshold usage
Adding a unit test to verify the use of the `linenothreshold` option
provided by the `highlight` directive [1]. The included document to test
will introduce two sets of `code-block` and `literalinclude` directives
where the first entry generates contents using line numbers and the
second entry generates contents not using line numbers, respectfully.

[1]: https://github.com/sphinx-doc/sphinx/blob/v1.8.4/sphinx/transforms/post_transforms/code.py#L85

Signed-off-by: James Knight <james.d.knight@live.com>
2019-02-16 22:14:30 -05:00
James Knight
0ded648c1a directive-code: do not force linenos value on run
Now that `highlightlang` directive is deprecated [1], the
`linenothreshold` option is to be used via the `highlight` directive.
The `highlight` directive will walk-through literal blocks to apply a
`linenos` value if:

 1) The literal block has not been explicitly configured with the
     `linenos` option.
 2) If there is enough content (when comparing literal block's line
     count to `linenothreshold`) that `linenos` should be explicitly
     enabled or disabled [2].

While the `hightlight` directive should be able to explicitly define if
a literal block needs to enable line numbers, the logic is always
ignored since the code block and literal include directives already
configures `linenos` when checking for line number-specific options on
the node [3][4]. This effectively prevents `linenothreshold` from being
used.

To allow `linenothreshold` to be used in literal blocks, this commit
disables the explicit configuration `linenos` on a literal block
instance when the `CodeBlock` and `LiteralInclude` directives are
processed.

[1]: b35198d847
[2]: https://github.com/sphinx-doc/sphinx/blob/v1.8.1/sphinx/transforms/post_transforms/code.py#L95-L97
[3]: https://github.com/sphinx-doc/sphinx/blob/v1.8.1/sphinx/directives/code.py#L156-L157
[4]: https://github.com/sphinx-doc/sphinx/blob/v1.8.1/sphinx/directives/code.py#L442-L444

Signed-off-by: James Knight <james.d.knight@live.com>
2019-02-16 22:14:30 -05:00
Takeshi KOMIYA
963d8bc4fc conf.py: Remove html_options from template 2019-02-17 01:16:01 +09:00
Takeshi KOMIYA
68f9339d7f conf.py: Remove html_sidebars from template 2019-02-17 01:15:44 +09:00
Takeshi KOMIYA
8f0b49a4cf Merge pull request #6051 from tk0miya/6026_xref_for_deflist
Fix #6026: LaTeX: A cross reference to definition list does not work
2019-02-17 00:39:47 +09:00
Takeshi KOMIYA
c67443f4a2 Merge branch '1.8' into 6026_xref_for_deflist 2019-02-17 00:24:25 +09:00
Takeshi KOMIYA
74ec98bb1d Merge pull request #6071 from tk0miya/6019_imgconverter_multipaged_PDF
Fix #6019: imgconverter: Including multipage PDF fails
2019-02-17 00:13:07 +09:00
Takeshi KOMIYA
63ccc34475 Merge pull request #6082 from tk0miya/refactor_XRefRole
refactor XRefRole using ReferenceRole class
2019-02-16 23:42:10 +09:00
Takeshi KOMIYA
a26e9f3d48 Merge pull request #6066 from tk0miya/4148_renew_quickstart_question
Closes #4148: quickstart: some questions are removed
2019-02-16 22:50:16 +09:00
Takeshi KOMIYA
c23835ef06 refactor XRefRole using ReferenceRole class 2019-02-16 21:47:15 +09:00
Takeshi KOMIYA
5437ab61e9 Merge pull request #6074 from tk0miya/1148_autodecorator
Closes #1148: autodoc: Add autodecorator directive for decorators
2019-02-16 21:45:36 +09:00
Takeshi KOMIYA
c0610cee64 Merge pull request #6041 from tk0miya/simplify_conf.py
Simplify conf.py
2019-02-16 21:44:28 +09:00
Takeshi KOMIYA
1ece29597e Merge branch 'master' into simplify_conf.py 2019-02-16 21:25:21 +09:00
Takeshi KOMIYA
61f1477942 Add testcase for XRefRole class 2019-02-16 21:23:01 +09:00
Takeshi KOMIYA
6748a6de2f Add testcase for download role 2019-02-16 21:23:01 +09:00
Takeshi KOMIYA
392f775cd1 Merge pull request #6081 from tk0miya/refactor_roles2
Replace :file: and :samp: roles by class based implementation
2019-02-16 20:56:10 +09:00
Takeshi KOMIYA
3ec032fa39 Replace :file: and :samp: roles by class based implementation 2019-02-16 12:37:46 +09:00
Takeshi KOMIYA
cd360471c9 Merge pull request #6080 from tk0miya/refactor_roles3
Replace :guilabel: and :menuselection: roles by class based implementation
2019-02-16 11:46:08 +09:00