Commit Graph

9665 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f366816968 Fix SphinxStandaloneReader.__init__() method has been duplicated 2018-01-08 20:31:57 +09:00
Takeshi KOMIYA
d9ae68b2ee Merge branch 'stable' 2018-01-07 12:16:17 +09:00
Takeshi KOMIYA
2ae7f26fe5 test: Adjust testcase for #3962 2018-01-07 12:09:41 +09:00
Takeshi KOMIYA
e18c49ec59 Merge commit '4277eb13315d5649401190df86874b3832ddfa3e' 2018-01-07 01:13:32 +09:00
Takeshi KOMIYA
65cd9429c0
Merge pull request #4381 from tk0miya/reduce_DeprecationWarning_on_testing
test: Reduce DeprecationWarning on testing (from docutils)
2018-01-06 16:28:18 +09:00
Takeshi KOMIYA
3736768a59 test: Reduce DeprecationWarning on testing (from docutils) 2018-01-06 15:56:37 +09:00
Jean-François B
79501767d8
Merge pull request #4360 from jfbu/4359_tame_docutils_conf
Do not apply smart quotes if Sphinx says no, even if Docutils says yes
2018-01-05 15:56:21 +01:00
jfbu
0d824dfd41 Update CHANGES for PR #4360 2018-01-05 15:16:23 +01:00
Takeshi KOMIYA
cc5d8a222f
Merge pull request #4380 from tk0miya/4378_usedevelop
Fix #4378: tox: use usedevelop option instead skipsdist
2018-01-05 23:13:13 +09:00
jfbu
bd139453c9 Move SphinxSmartQuotes transform to SphinxStandaloneReader
closes #4142
closes #4357
closes #4359
refs: #3967

Adds ``smartquotes``, ``smartquotes_action``, ``smartquotes_excludes``
configuration variables.

- if ``smartquotes`` is set to False, then Smart Quotes transform is not
  applied even if a Docutils configuration file activates it,

- the current default of ``smartquotes_excludes`` deactivates Smart
  Quotes for Japanese language, and also for the ``man`` and ``text``
  builders.

  However, currently ``make text html`` deactivates Smart Quotes for
  ``html`` too, and ``make html text`` activates them for ``text`` too,
  because the picked environment is shared and already transformed.

- now Smart Quotes get applied also when source documents are in
  Markdown or other formats.
2018-01-05 15:06:10 +01:00
Takeshi KOMIYA
e3efe5884b Fix #4378: tox: use usedevelop option instead skipsdist 2018-01-05 22:26:07 +09:00
Takeshi KOMIYA
4277eb1331
Merge pull request #4373 from tk0miya/4369_show_traceback_on_exception_from_conf.py
Show traceback if conf.py raises an exception (refs: #4369)
2018-01-05 14:18:43 +09:00
Takeshi KOMIYA
ff61fb80c5
Merge pull request #4377 from timhoffm/searchbar-style
Improved sidebar search field style
2018-01-05 14:12:07 +09:00
Tim Hoffmann
b04151bca8 improved sidebar search field style 2018-01-05 02:02:40 +01:00
Takeshi KOMIYA
6fa344c951 Show traceback if conf.py raises an exception (refs: #4369) 2018-01-03 20:15:45 +09:00
jfbu
c892fe98f7 Fix space gobbling issue from PR #4370
This is subtle LaTeX thing. Prior to merge of #4370 there was a
`\texttt` which was hiding the potential problem. The fix is to leave a
brace pair in place.
2018-01-03 10:50:18 +01:00
Jean-François B
5d31fada70
Merge pull request #4370 from jfbu/easier_sphinxcode
Easy-up user customization of ``\sphinxcode`` LaTeX macro
2018-01-03 09:32:50 +01:00
jfbu
680d6766bb Make LaTeX macro definitions more readable
This make clearer to average LaTeX user the format which is expected for
these macros, in case of redefinitions.
2018-01-03 08:46:33 +01:00
jfbu
309f38a91f Split out fancy LaTeX macros from `\sphinxcode into \sphinxupquote`
Since #2627 (1.4.4), `\code`, and then again at #3116 (1.5)
`\sphinxcode` which is the new name has become more complicated than the
original `\texttt{#1}`. This was to obtain straight quotes in PDF output,
and to allow long inline literals to break across lines.

This means though that users who want to customize `\sphinxcode`, for
example to not only do `\texttt` but to use some colour, have to copy
about 10 lines of complicated LaTeX macros which should be not modified
in any way. This commit moves all the code out of `\sphinxcode` into a
separate macro `\sphinxupquote`.

The LaTeX writer will output `\sphinxcode{\sphinxupquote{foo}}` in place
of former `\sphinxcode{foo}`. Moving the `\texttt` from innermost to
outermost level is with no consequence.
2018-01-03 08:46:19 +01:00
Takeshi KOMIYA
369d66e41e
Merge pull request #4368 from tk0miya/4091_private_members_isnt_documented
Fix #4091: Private members not documented without :undoc-members:
2018-01-03 09:43:29 +09:00
Takeshi KOMIYA
cb860f0d30 Fix #4091: Private members not documented without :undoc-members: 2018-01-02 01:57:41 +09:00
Takeshi KOMIYA
4bc4b35352
Merge pull request #4367 from tk0miya/3769_regulate_optionref
3769 regulate optionref
2018-01-02 01:29:46 +09:00
Takeshi KOMIYA
850e9a9c5c Fix links to external option docs with intersphinx (refs: #3769) 2018-01-02 01:01:29 +09:00
Takeshi KOMIYA
f21fe6f24f Revert "tox: Enable 'skipsdist'"
This reverts commit 69f39e44d9.
2018-01-01 23:03:15 +09:00
Stephen Finucane
69f39e44d9 tox: Enable 'skipsdist'
Given that we install Sphinx as part of the dependencies, there's no
reason to do it twice. Skip that step.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-01 18:47:12 +09:00
Takeshi KOMIYA
023dad6c66
Merge pull request #4335 from zufallsgenerator/fix-4334-apidoc-toc-inconsistencies
Closes #4334: sphinx-apidoc: References to non-existing files in TOC
2018-01-01 12:03:32 +09:00
Takeshi KOMIYA
d4728d0cb8
Merge pull request #4365 from tk0miya/happy_new_year2
A happy new year! (master)
2018-01-01 10:40:47 +09:00
Takeshi KOMIYA
0b247ff1f7
Merge pull request #4364 from tk0miya/happy_new_year
A happy new year! (stable)
2018-01-01 10:40:03 +09:00
Takeshi KOMIYA
5562e76585 A happy new year! 2018-01-01 01:10:10 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Takeshi KOMIYA
e8402bf0ee Merge branch 'stable' 2017-12-31 21:13:34 +09:00
Takeshi KOMIYA
fce7f38b71
Merge pull request #4217 from Smattr/4a164170-33e9-4df3-aad2-a13af37b6b43
Fix #4214: Two todolist directives break sphinx-1.6.5
2017-12-31 21:05:38 +09:00
Takeshi KOMIYA
1cae50f748
Merge branch 'stable' into 4a164170-33e9-4df3-aad2-a13af37b6b43 2017-12-31 20:43:16 +09:00
jfbu
0059c05a85 Rename smartquotable to notsmartquotable for intelligibility 2017-12-30 11:03:43 +01:00
Takeshi KOMIYA
40186077d7
Merge pull request #4358 from tk0miya/ensure_parallelism
Ensure parallelism
2017-12-30 10:04:22 +09:00
Takeshi KOMIYA
d7aa98aed7 Fix flake8 violations 2017-12-30 01:21:22 +09:00
Takeshi KOMIYA
a260a9ea15
Merge pull request #4338 from stephenfin/test-cleanup
Test cleanup
2017-12-30 01:20:05 +09:00
Takeshi KOMIYA
1d3362425b Add app.is_parallel_allowed() 2017-12-30 00:54:55 +09:00
Takeshi KOMIYA
54699dd263 Fix parallel_write_safe check was wrong 2017-12-30 00:38:17 +09:00
Takeshi KOMIYA
9ddb51ea2f
Merge pull request #4352 from jakobandersen/io_parallel
Fix missing metainfo for sphinx.io
2017-12-30 00:34:55 +09:00
Stephen Finucane
60e25090a3 tox: Enable 'skipsdist'
Given that we install Sphinx as part of the dependencies, there's no
reason to do it twice. Skip that step.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:33 +00:00
Stephen Finucane
9a3ebaaff5 Resolve warning filter issues
There's an issue with 'pkgutils' and namespace packages. This has been
reported against setuptools [1], but until this is resolved, we simply
need to live with it. Ensure said warnings are filtered from tox too and
remove some unnecessary ones.

[1] https://github.com/pypa/setuptools/issues/1111

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:32 +00:00
Stephen Finucane
7c0723fd46 tests: Remove 'tests/run.py'
This is no longer necessary. One test needs to be modified to deal with
how 'python -m pytest' modifies the PATH.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:31 +00:00
Stephen Finucane
529c96a3c9 tests: Use 'pytest_sessionstart'
This is the recommended way to do pre-session configuration in pytest if
not using session fixtures [1].

With this, we're able to remove the custom 'test/run.py' script in its
entirety and run 'pytest' like everyone else does. We'll do this
separately to keep things simple.

[1] https://stackoverflow.com/a/12600154/613428

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:26 +00:00
Stephen Finucane
c33ecd1f8f tests: Use 'pytest_report_header'
This is the recommended way to print extra headers [1].

[1] https://docs.pytest.org/en/latest/example/simple.html#adding-info-to-test-report-header

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:07 +00:00
Stephen Finucane
9348c4bea1 tests: Stop explicitly checking for modules
This will have already been handled by setuptools. If the user isn't
using this then they've dug their own grave.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:02:04 +00:00
Stephen Finucane
4fd217ce88 circleci: Install packages ourselves
Start installing Python dependencies and Sphinx itself as part of the
CircleCI job rather than expecting it to be done in the Docker
container. This ensures we will use the version of the packages for a
given commit.

This is the other half of sphinx-doc/docker-ci#1.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-12-29 13:01:59 +00:00
Takeshi KOMIYA
0998bd5330
Merge pull request #4355 from stephenfin/remove-epub3-references
templates: Remove 'epub3' targets
2017-12-29 10:30:55 +09:00
Takeshi KOMIYA
8c542e1222
Merge pull request #4356 from stephenfin/bug/2250
doc: Add missing sphinx-apidocs opt, envvar
2017-12-29 10:02:43 +09:00