Commit Graph

11033 Commits

Author SHA1 Message Date
Jean-François B
276d1c26c4
Merge pull request #5135 from jfbu/5133_latex_index_itln
Fix: #5133 via ``\sphinxsymbolsname``, ``\sphinxnumbersname``
2018-07-16 09:21:21 +02:00
jfbu
fb45af7cde Rename macros for conformity with choices done at PR #5134 2018-07-16 01:57:40 +02:00
Takeshi KOMIYA
9bc2a93d36
Merge pull request #5170 from tk0miya/5143_autodoc_crashed_on_inspecting
Fix #5143: autodoc: crashed on inspecting dict like object
2018-07-15 18:10:21 +09:00
Takeshi KOMIYA
2d7fe69362 Fix #5143: autodoc: crashed on inspecting dict like object 2018-07-15 15:44:31 +09:00
Takeshi KOMIYA
1bece0fbf6
Merge pull request #5169 from tk0miya/master
Merge 1.7 branch into master
2018-07-15 15:28:00 +09:00
Takeshi KOMIYA
2e4db4854f Fix flake8 violation 2018-07-15 15:15:57 +09:00
Takeshi KOMIYA
a54abd760c Fix mypy violations 2018-07-15 14:55:22 +09:00
Takeshi KOMIYA
bfe7bb819d Merge branch '1.7' 2018-07-15 14:55:15 +09:00
Takeshi KOMIYA
453fe5ec1a
Merge pull request #5168 from tk0miya/mypy-0.620
Fix mypy violations
2018-07-15 14:50:30 +09:00
Takeshi KOMIYA
e34fd5b503 Fix mypy violations 2018-07-15 14:07:00 +09:00
Takeshi KOMIYA
6ee03240b4
Merge pull request #5151 from tk0miya/5146_wrong_location_for_autosummary_warning
Fix autosummary: warnings of autosummary indicates wrong location (refs: #5146)
2018-07-14 22:31:50 +09:00
Takeshi KOMIYA
e222b38d85
Merge branch '1.7' into 5146_wrong_location_for_autosummary_warning 2018-07-13 01:57:57 +09:00
Takeshi KOMIYA
9fcbfa859e
Merge pull request #5152 from tk0miya/5146_autosummary_and_literal_notation
Fix #5146: autosummary: warning is emitted when the first line of docstring ends with literal notation
2018-07-13 01:56:52 +09:00
Takeshi KOMIYA
20480f4857
Merge branch '1.7' into 5146_autosummary_and_literal_notation 2018-07-13 01:18:19 +09:00
Takeshi KOMIYA
b2ce178d7e
Merge pull request #5131 from tk0miya/5125_wrong_sphinx.main
Fix #5125: sphinx-build: Interface of ``sphinx:main()`` has changed
2018-07-13 00:39:33 +09:00
Takeshi KOMIYA
4aeb94a7a2
Merge branch '1.7' into 5125_wrong_sphinx.main 2018-07-12 21:17:29 +09:00
Takeshi KOMIYA
2e66ffba57 Update CHANGES for PR #5119 2018-07-09 10:44:14 +09:00
Takeshi KOMIYA
a2f6de88c1 Fix #5146: autosummary: warning is emitted when the first line of docstring ends with literal notation 2018-07-08 21:14:01 +09:00
Takeshi KOMIYA
d6c85619b4 Fix autosummary: warnings of autosummary indicates wrong location (refs: #5146) 2018-07-08 20:41:38 +09:00
jfbu
e7ee035050 LaTeX use `\sphinxstyleindexletterhead` also for domain indices 2018-07-04 08:37:57 +02:00
jfbu
46bc56636e Fix: #5133 via `\sphinxsymbolsname, \sphinxnumbersname`
Also adds usage of \sphinxstyleindexletterhead in python.ist as a
customizable alias of original \bigletter.
2018-07-04 08:32:02 +02:00
Michel Alexandre Salim
b553c23ab1 Closes #5076: [ext/napoleon] explicitly catch StopIteration (#5119)
* Closes #5076: [ext/napoleon] explicitly catch StopIteration

Per PEP 479, Python 3.7 no longer allows bubbling up StopIteration
outside of a generator. Instead, wrap attribute parsing in a try
block and provide a sane default in case it raises an exception
([]).

* Fix mypy and flake8 issues
2018-07-03 12:28:54 -04:00
Takeshi KOMIYA
b8f4e5d142 Fix sphinx-build: `sphinx.cmd.build.main() refers sys.argv` instead of given argument 2018-06-30 01:46:04 +09:00
Takeshi KOMIYA
b6c4ebc37a Fix #5125: sphinx-build: Interface of `sphinx:main()` has changed 2018-06-30 01:43:54 +09:00
Takeshi KOMIYA
1140e81df7 Merge remote-tracking branch 'stephenfin/doc-rework' 2018-06-26 01:05:19 +09:00
Takeshi KOMIYA
1ebf6d4983
Merge pull request #5111 from stephenfin/tox-fixes
Run everything but unit tests under Python 3
2018-06-26 00:59:36 +09:00
Takeshi KOMIYA
1a477397b2
Merge pull request #5120 from blueyed/fix-doc
doc: fix list with add_object_type
2018-06-26 00:40:22 +09:00
Takeshi KOMIYA
148b47168c
Merge pull request #5123 from blueyed/doc-fixes
doc: fix func/meth references to Sphinx
2018-06-25 22:28:37 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02:00
Daniel Hahler
c2b85b923f doc: fix list with add_object_type
This seems to have been accidentally broken in eaaab75ec.
2018-06-25 06:38:32 +02:00
Takeshi KOMIYA
e1201f2779
Merge pull request #5115 from althonos/patch-1
Update napoleon docs with features from #4613
2018-06-23 13:16:05 +09:00
Takeshi KOMIYA
6714e034ac
Merge pull request #5001 from tk0miya/1431_latex_enumlist
Close #1431: latex: Add alphanumeric enumerated list support
2018-06-22 02:28:26 +09:00
Takeshi KOMIYA
41b250c804 Fix flake8 violation 2018-06-22 00:55:07 +09:00
Takeshi KOMIYA
f518d26e45 Merge branch 'master' into 1431_latex_enumlist 2018-06-22 00:27:49 +09:00
Takeshi KOMIYA
3d180f9385 Merge branch '1.7' 2018-06-21 23:23:30 +09:00
Stephen Finucane
3eb26a3335 travis: Run flake8 against Python 3.6
As with tox and make before it, we run everything that we can against
Python 3 (Python 3.6 in this case).

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-21 15:11:42 +01:00
Stephen Finucane
2a4827af4f make: Default to Python 3
As with the tox change, it makes sense to test things against Python 3
by default now, seeing as that will be the only version supported in
Sphinx 2.0.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-21 15:11:35 +01:00
Martin Larralde
b2a46c5af9 Add documentation change to changelog 2018-06-21 14:24:28 +02:00
Martin Larralde
14ecf47296 Add @althonos to contributors 2018-06-21 14:23:45 +02:00
Martin Larralde
a68298b7d8
Update napoleon docs with features from #4613 2018-06-21 14:10:52 +02:00
Takeshi KOMIYA
f14d60dcd2
Merge pull request #5096 from tk0miya/update_docs
doc: update URL of PDF and EPUB
2018-06-21 01:29:42 +09:00
jfbu
dbb04d0a33 Obide by Docutils `node['prefix'] and node['suffix']` 2018-06-20 18:11:11 +02:00
Takeshi KOMIYA
e78133a83e
Merge pull request #5106 from tk0miya/5104_broken_apidoc_main
Fix #5104: apidoc: Interface of ``sphinx.apidoc:main()`` has changed
2018-06-20 22:14:01 +09:00
Takeshi KOMIYA
f54d886a61
Merge branch '1.7' into 5104_broken_apidoc_main 2018-06-20 22:01:25 +09:00
Takeshi KOMIYA
6e27f6c336
Merge pull request #5107 from tk0miya/5070_epub_wrong_anchor
Fix #5070: epub: Wrong internal href fragment links
2018-06-20 21:42:20 +09:00
Stephen Finucane
93589a3572 tox: Run everything but unit tests under Python 3
The demise of Python 2.7 is not far off and we intend to drop support
for it in Sphinx 2.0. As a result, there probably isn't a better time
than now to start testing with Python 3 by default. There are a couple
of advantages to this:

- flake8 is stricter under Python 3 and we don't need to ignore files
  with Python 3 syntax
- We get to dogfood Sphinx against its own documentation using Python 3
- pylint gains support for Python 3 syntax

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:53:29 +01:00
Stephen Finucane
c0f42b6519 Escape raw strings
These were resulting in the below warning messages when running flake8
under Python 3.6.

    :48: DeprecationWarning: invalid escape sequence \[
    :143: DeprecationWarning: invalid escape sequence \-
    :250: DeprecationWarning: invalid escape sequence \s

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:51:55 +01:00
Stephen Finucane
d9ccc95717 doc: Add "extensions" to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:30:47 +01:00
Stephen Finucane
0b81af6a2e doc: Rework "extensions" documents
This is mostly spacing and other "niceness" fixes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Stephen Finucane
b595c4a45b doc: Add "builders" to usage guide
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00