Commit Graph

11490 Commits

Author SHA1 Message Date
Jon Dufresne
02fea029bf Prefer builtin open() over io.open() and codecs.open()
In Python3, the functions io.open() is an alias of the builtin open()
and codecs.open() is functionally equivalent. To reduce indirection,
number of imports, and number of patterns, always prefer the builtin.

https://docs.python.org/3/library/io.html#high-level-module-interface

> io.open()
>
> This is an alias for the builtin open() function.
2018-09-11 05:45:36 -07:00
shimizukawa
844a3a5c22 add books written with using Sphin 2018-09-10 23:45:06 +09:00
Takayuki SHIMIZUKAWA
e23ede82f3 Merge pull request #5408 from sphinx-doc/shibukawa-patch-1
Update EXAMPLES to add books
2018-09-10 23:42:54 +09:00
Yoshiki Shibukawa
e2544cfd34 Update EXAMPLES 2018-09-10 23:02:54 +09:00
Yoshiki Shibukawa
22c9e92019 Update EXAMPLES 2018-09-10 23:00:58 +09:00
Yoshiki Shibukawa
c9d6c4bca5 Update EXAMPLES
Add my books that were written by Sphinx
2018-09-10 21:50:06 +09:00
Takeshi KOMIYA
c57853923f Merge pull request #5393 from tk0miya/refactor_app
refactor: Check primary_domain on config-inited event
2018-09-10 20:46:26 +09:00
Takeshi KOMIYA
d9c308a299 Merge pull request #5406 from jdufresne/bytes-type
Correct some unicode/str types to bytes
2018-09-10 20:45:34 +09:00
Takeshi KOMIYA
4e48019b90 Merge pull request #5402 from jdufresne/getcwdu
Remove use of Python 2 os.getcwdu()
2018-09-10 20:42:08 +09:00
Jon Dufresne
38709af87b Correct some unicode/str types to bytes
More explicit and more forward compatible with Python 3.
2018-09-09 15:08:44 -07:00
Jon Dufresne
1d11a297a3 Remove use of Python 2 os.getcwdu()
os.getcwdu() is Python 2 only. It was removed from Python 3. As Sphinx
is now Python 3 only, can remove the workaround.

$ python2 -c 'import os; print(os.getcwdu)'
<built-in function getcwdu>
$ python3 -c 'import os; print(os.getcwdu)'
Traceback (most recent call last):
  File "<string>", line 1, in <module>
AttributeError: module 'os' has no attribute 'getcwdu'

sphinx.util.osutil.getcwd() is now deprecated for removal.
2018-09-09 11:36:34 -07:00
Takeshi KOMIYA
ffaa528c98 Merge pull request #5390 from tk0miya/4018_htmlhelp_file_suffix
Fix #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix
2018-09-09 19:35:49 +09:00
Takeshi KOMIYA
02afc357ef Merge branch '1.8' 2018-09-09 19:26:48 +09:00
Takeshi KOMIYA
d1eecb1307 Merge branch '1.7' into 1.8 2018-09-09 19:22:35 +09:00
Takeshi KOMIYA
189072dbc9 Merge pull request #5404 from tk0miya/test_DO_EPUBCHECK
Add $DO_EPUBCHECK envvar as a workaround for #4611
2018-09-09 19:21:49 +09:00
Takeshi KOMIYA
973986cfdb Add $DO_EPUBCHECK envvar as a workaround for #4611 2018-09-09 19:09:56 +09:00
Takeshi KOMIYA
578adb887f Merge pull request #5400 from tk0miya/5399_find_catalog_crashes
Fix #5399: Sphinx crashes if unknown po file exists
2018-09-09 18:38:21 +09:00
Takeshi KOMIYA
85d954cb96 Merge pull request #5396 from jdufresne/tox-pypy
Remove pypy from tox.ini
2018-09-09 17:18:55 +09:00
Takeshi KOMIYA
07fd1c0680 Fix #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix 2018-09-08 23:11:14 +09:00
Takeshi KOMIYA
02b763bc71 refactor: Check primary_domain on config-inited event 2018-09-08 22:47:45 +09:00
Takeshi KOMIYA
8e729b419e Fix #5399: Sphinx crashes if unknown po file exists 2018-09-08 22:21:59 +09:00
Takeshi KOMIYA
0970619813 Merge pull request #5392 from tk0miya/5290_support_egged_source_code
Fix #5290: autodoc: failed to analyze source code in egg package
2018-09-08 22:15:14 +09:00
Jon Dufresne
b36cc52c7d Remove pypy from tox.ini
The pypy executable is Python 2 and Python 2 support was dropped in
commit 9412bd76b7.
2018-09-07 16:15:20 -07:00
Takeshi KOMIYA
35e1764025 Fix #5290: autodoc: failed to analyze source code in egg package 2018-09-06 22:22:01 +09:00
Takeshi KOMIYA
888eea2944 Merge pull request #5378 from tk0miya/5127_quickstart_should_not_overwrite_Makefiles
Fix #5127: quickstart: ``Makefile`` and ``make.bat`` are not overwritten if exists
2018-09-06 22:19:50 +09:00
Takeshi KOMIYA
d9694befae Merge branch '1.8' into 5127_quickstart_should_not_overwrite_Makefiles 2018-09-06 21:35:55 +09:00
Takeshi KOMIYA
dfbf90a128 Merge pull request #5375 from tk0miya/5362_apidoc_toc
Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToC
2018-09-06 21:33:19 +09:00
Takeshi KOMIYA
86abb57577 Fix #5362: apidoc: Add `--toc` option to change the filename of ToC 2018-09-06 18:29:44 +09:00
Takeshi KOMIYA
4abc55239a Merge pull request #5377 from tk0miya/4034_fix_download_url2
Fix #2720, #4034: Incorrect links with ``:download:``, duplicate names, and parallel builds
2018-09-06 18:24:42 +09:00
Takeshi KOMIYA
9553453424 Merge pull request #5386 from tk0miya/add_IndexEntriesMigrator
refactor: Add IndexEntriesMigrator to simplify
2018-09-06 02:05:54 +09:00
Takeshi KOMIYA
a2d5c79114 Merge branch '1.8' into 4034_fix_download_url2 2018-09-06 02:00:37 +09:00
Takeshi KOMIYA
811d23fa4d Merge pull request #5383 from tk0miya/fix_ImportError_is_replaced
Fix autodoc: ImportError is replaced by AttributeError for deeper module
2018-09-06 01:54:24 +09:00
Takeshi KOMIYA
df8e1a4cbc Update CHANGES for PR #5388 2018-09-06 01:09:40 +09:00
Takeshi KOMIYA
750e037ce6 Merge pull request #5388 from lamby/reproducbible-frozenset
Ensure frozen object descriptions are reproducible
2018-09-06 01:08:32 +09:00
Takeshi KOMIYA
28e05b131e Merge branch '1.8' into fix_ImportError_is_replaced 2018-09-06 00:09:45 +09:00
Takeshi KOMIYA
f7e556c1db Merge pull request #5376 from tk0miya/2401_members_conflicts_with_special_members
Fix #2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shown
2018-09-06 00:06:25 +09:00
Chris Lamb
17d32d625b Ensure frozenset object descriptions are reproducible
Whilst working on the Reproducible Builds effort [0], we noticed
that sphinx could generate output that is not reproducible.

In particular, the rendering of `frozenset` objects in default
arguments and elsewhere is currently non-determinstic.

For example:

    frozenset(['a', 'b', 'c'])

Might be rendered as any of:

    frozenset({'a', 'b', 'c'})
    frozenset({'a', 'c', 'b'})
    frozenset({'b', 'a', 'c'})
    frozenset({'b', 'c', 'a'})
    frozenset({'c', 'a', 'b'})
    frozenset({'c', 'b', 'a'})

Patch attached that sorts the contents of frozensets whilst rendering.
This is parallel to the `dict` and `set` type logic

  [0] https://reproducible-builds.org/
2018-09-05 15:58:54 +01:00
Takeshi KOMIYA
342de4f0fd Merge branch '1.8' 2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
3d35723f6d Merge branch '1.7' into 1.8 2018-09-05 23:09:48 +09:00
Takeshi KOMIYA
403f7edb17 Bump version 2018-09-05 23:07:09 +09:00
Takeshi KOMIYA
1cd87a11ef Bump to 1.7.9 final v1.7.9 2018-09-05 23:05:02 +09:00
Takeshi KOMIYA
c9826fe676 Merge branch '1.8' into 2401_members_conflicts_with_special_members 2018-09-05 23:00:13 +09:00
Takeshi KOMIYA
c67c08fc7b Merge pull request #5374 from tk0miya/4379_toctree_and_exclude_patterns
Fix #4379: toctree shows confusible warning when document is excluded
2018-09-05 22:57:28 +09:00
Takeshi KOMIYA
aa3e590d5e Merge pull request #5370 from tk0miya/drop_deprecated_methods
Drop APIs deprecated in 2.0
2018-09-05 22:56:02 +09:00
Takeshi KOMIYA
79de756423 Merge pull request #5342 from tk0miya/drop_py2_support
Update requirements and dependencies for Sphinx-2.0
2018-09-05 22:55:07 +09:00
Takeshi KOMIYA
80f5371928 refactor: Add IndexEntriesMigrator to simplify 2018-09-04 01:20:34 +09:00
Takeshi KOMIYA
e07731e7b1 Fix autodoc: ImportError is replaced by AttributeError for deeper module 2018-09-03 22:49:01 +09:00
Takeshi KOMIYA
bb29813dc8 Merge pull request #5381 from TAKEDA-Takashi/fix-docs-mecabsplitter
docs: Fix wrong name of MecabSplitter
2018-09-03 22:36:08 +09:00
TAKEDA-Takashi
683cccac4d docs: Fix wrong name of MecabSplitter 2018-09-03 16:18:24 +09:00
Takeshi KOMIYA
daac35cda7 doc: Add versionadded label (refs: #5029) 2018-09-03 10:46:38 +09:00