Dmitry Shachnev
1e11634d51
Add a failing test for formatting Tuple[int, str, int]
2018-07-13 21:21:49 +03: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
jfbu
799c0af6e8
LaTeX: for French and xelatex, use babel not polyglossia ( fix : #4272 )
2018-07-12 15:08:54 +02:00
Takeshi KOMIYA
4aeb94a7a2
Merge branch '1.7' into 5125_wrong_sphinx.main
2018-07-12 21:17:29 +09:00
jfbu
a68d06a1da
LaTeX: fix indexing of terms containing " character
2018-07-11 18:49:03 +02:00
jfbu
7166451dbd
LaTeX: fix indexing of terms containing ! character
2018-07-11 18:49:03 +02:00
jfbu
f0eeb5457c
LaTeX: fix indexing of terms containing @ character
2018-07-11 18:49:03 +02:00
Dan Abdinoor
83c9380299
Fix links to sphinx-build man page
...
Swap``program`` for ``doc`` links to sphinx-build man page.
2018-07-10 12:14:45 -04: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
35c69ccfb5
Fix line too long
2018-07-04 08:46:25 +02: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
jfbu
a6d063eb01
LaTeX: improve customizabilty of Sphinx generated indices
2018-07-03 14:47:43 +02:00
Honza Javorek
271e1d1340
make linter happy
2018-07-03 14:13:46 +02:00
Honza Javorek
6fe8835037
add default Accept header
...
There are situations where requested server replies with a different content (in my particular case HTTP 404) when there is no accept header, possibly because it evaluates the content negotiation to an API request instead of a browser request. This change adds a default Accept header, which equals to what my Firefox sets out of the box to its requests.
I stumbled upon this when checking a link to https://crates.io/crates/dredd-hooks . While
curl -i https://crates.io/crates/dredd-hooks
returns HTTP 404, following results in an expected HTTP 200 response with HTML body:
curl -H 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8' -i https://crates.io/crates/dredd-hooks
2018-07-03 14:00:33 +02:00
Timotheus Kampik
94b467dbc8
#4255 clarify documentation of `startdocname
` parameters.
...
* Relative path from source directory
* Similar to ``master_doc`` in functionality
2018-07-01 16:10:51 +02:00
jfbu
5a383e13e6
Fix flake8
2018-07-01 00:21:44 +02:00
jfbu
90c2b528b1
Update docs and CHANGES for `latex_use_xindy
` config variable
2018-06-30 23:37:26 +02:00
jfbu
0f5d5ac126
Add `latex_use_xindy
` new config variable for UTF-8 enabled indices
...
Fix : #5132
2018-06-30 23:03:30 +02: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
910be1e2a2
Close #4976 : `SphinxLoggerAdapter.info()
now supports
location
` parameter
2018-06-26 01:02:37 +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
4cd90a644a
BuildDoc: add and pass through nitpicky option
...
This allows for using e.g. `tox -e docs -- -n` with Sphinx's own
`build_sphinx` distutils command.
2018-06-25 08:04:07 +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