Commit Graph

10233 Commits

Author SHA1 Message Date
Patrick Wingo
e505cbb3be Napoleon: custom section headers (#4387)
* Changes to allow for custom sections in google/numpy comments when parsing with napoleon

* fixed some formatting to pass flake8 tests
2018-02-15 16:16:23 -05:00
Takeshi KOMIYA
b5bae235f2 Fix #4615: The argument of `sphinx.build` has been changed in 1.7.0 2018-02-16 02:08:56 +09:00
Takeshi KOMIYA
911f74f467 Fix #4623: sphinx.build_main no longer exists in 1.7.0 2018-02-16 02:08:39 +09:00
Akihiro Takizawa
3efc8e957a key changes to scheme in epub3 opf template 2018-02-15 14:28:55 +09:00
Takeshi KOMIYA
01da85fbe2 Fix #4617: quickstart: PROJECT_DIR argument is required 2018-02-15 01:57:26 +09:00
Takeshi KOMIYA
5d1b8ff55f Fix mypy violations 2018-02-14 22:57:41 +09:00
Takeshi KOMIYA
a073e17537 Use typing.TYPE_CHECKING for typehints 2018-02-14 22:57:38 +09:00
Takeshi KOMIYA
26592abbab
Merge pull request #4599 from tk0miya/4260_kwarg_separator_is_disappeared
Fix #4260: autodoc: keyword only argument separator is not disappeared
2018-02-14 10:12:37 +09:00
Rob Ruana
2602be13bc
Merge pull request #4613 from althonos/master
[Napoleon] Implement missing napoleon admonitions
2018-02-13 12:03:51 -05:00
Martin Larralde
4d7c90d857 Implement missing napoleon admonitions 2018-02-13 18:02:02 +01:00
Takeshi KOMIYA
5b02d61a04 Use roots/basic for test_latex_logo_if_not_found 2018-02-14 01:35:00 +09:00
Takeshi KOMIYA
d315f9e251
Merge pull request #4598 from stephenfin/makefile-cleanup
Makefile cleanup
2018-02-14 00:40:22 +09:00
Takeshi KOMIYA
1d0f7827fc
Merge branch '1.7' into 4260_kwarg_separator_is_disappeared 2018-02-14 00:38:48 +09:00
Takeshi KOMIYA
044c851577
Merge pull request #4601 from sphinx-doc/update_release_checklist
docs: protect and unprotect the stable branch on releasing
2018-02-14 00:38:01 +09:00
Thijs Triemstra
91807f882d fix broken links on pypi page 2018-02-14 00:37:16 +09:00
Takeshi KOMIYA
52fd0f2525
Merge pull request #4603 from tk0miya/fix_indentation
Fix indentation
2018-02-14 00:36:34 +09:00
Takeshi KOMIYA
0e39d7f6e8
Merge pull request #4607 from thijstriemstra/patch-2
fix broken contributor page links on pypi page
2018-02-14 00:36:01 +09:00
Takeshi KOMIYA
82d09f2256
Merge pull request #4610 from tk0miya/4608_invalid_metatag_for_epub
Fix #4608: epub: Invalid meta tag is generated
2018-02-14 00:34:24 +09:00
Takeshi KOMIYA
7cf1520c10 Fix #4608: epub: Invalid meta tag is generated 2018-02-13 21:00:46 +09:00
Thijs Triemstra
6ee4a6bc14
fix broken links on pypi page 2018-02-12 22:57:05 +01:00
Takeshi KOMIYA
795ca7a0c9 Fix #4260: autodoc: keyword only argument separator is not disappeared 2018-02-13 02:13:38 +09:00
Takeshi KOMIYA
053ac8c401 Fix indentation 2018-02-12 23:54:38 +09:00
Takeshi KOMIYA
4b0cff0253 docs: protect and unprotect the stable branch on releasing 2018-02-12 22:54:38 +09:00
Takeshi KOMIYA
2a65ffeef5
Merge pull request #4597 from tk0miya/4596_issubclass
Fix #4596: TypeError: issubclass() arg 1 must be a class
2018-02-12 20:58:11 +09:00
Stephen Finucane
c8d1db72a8 make: Group test commands together
We may want to eventually deprecate these in favour of 'tox', but this
cleans things up a little until then.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-12 11:52:53 +00:00
Stephen Finucane
690714f4c4 make: Remove deprecated targets
These have been deprecated for a while and can now be removed.

Some indentation is also fixed, while we're at it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-12 11:52:53 +00:00
Takeshi KOMIYA
6cf0698b0c Merge branch '1.7' 2018-02-12 16:20:00 +09:00
Takeshi KOMIYA
419021e82f Bump version 2018-02-12 16:16:20 +09:00
Takeshi KOMIYA
34a20bf10b Bump to 1.7.0 final 2018-02-12 16:14:07 +09:00
Takeshi KOMIYA
bc068e4143 Update message catalogs 2018-02-12 16:10:01 +09:00
Takeshi KOMIYA
ad967433ef
Merge pull request #4593 from tk0miya/optimize
optimize: Don't use transform to process only nodes on resolving toctree
2018-02-12 10:58:45 +09:00
Takeshi KOMIYA
106dc20ce2
Merge pull request #4592 from tk0miya/4581_shall_skip_ignores_excluded_modules
Fix #4581: apidoc: Excluded modules still included
2018-02-12 10:57:32 +09:00
Takeshi KOMIYA
bd0b4204ca Fix #4596: TypeError: issubclass() arg 1 must be a class 2018-02-12 10:23:01 +09:00
Takeshi KOMIYA
e700f0ba99 Fix #4581: apidoc: Excluded modules still included 2018-02-11 22:10:33 +09:00
Takeshi KOMIYA
e5adf8ce91 Merge branch '1.7-release' 2018-02-11 19:35:48 +09:00
Takeshi KOMIYA
4ef4ef7d14 optimize: Don't use transform to process only nodes on resolving toctree
This avoid to use ``SphinxTransformer`` to apply ``process_only_nodes``
on resolving toctree.  It can skip to generate documentation node.  The
generation is too heavy process only for single transformation.
2018-02-11 19:28:48 +09:00
Takeshi KOMIYA
4a96f85119
Merge pull request #4591 from tk0miya/autosectionlabel-smart-quotes-fix
Fix #4027: use rawsource in autosectionlabel extension
2018-02-11 14:21:42 +09:00
Takeshi KOMIYA
ae38d556b7 Combine tests for autosectionlabel 2018-02-11 13:54:47 +09:00
Kit La Touche
481b1ad535 Remove extraneous import 2018-02-11 13:53:29 +09:00
Kit La Touche
4beb4d0066 Fix unicode issues 2018-02-11 13:53:29 +09:00
Kit La Touche
29a3fd0acb Handle older docutils 2018-02-11 13:53:29 +09:00
Kit La Touche
f21b9d5892 Use rawsource in autosectionlabel
Fixes #4027.
2018-02-11 13:52:27 +09:00
Takeshi KOMIYA
87a9a86de9
Merge pull request #4565 from tk0miya/update_release_checklist
Add procedures for beta and final releases
2018-02-11 12:18:10 +09:00
Takeshi KOMIYA
b53c69a4e0
Merge pull request #4588 from tk0miya/4564_rst_prolog_not_working
io: Choose FileInput using ``supported`` attribute (refs: #4564)
2018-02-11 11:00:22 +09:00
Takeshi KOMIYA
a2085dd351
Merge pull request #4589 from tk0miya/fix_condition_for_deprecation_warnings
Fix condition for deprecation warning
2018-02-11 02:58:00 +09:00
Takeshi KOMIYA
b6c92bec8b
Merge pull request #4568 from stephenfin/doc-rework
Doc rework (user guide, part 1)
2018-02-11 02:57:17 +09:00
Stephen Finucane
cb4b7177d8 doc: Create usage guide section
Start structuring our docs a little better starting with a usage guide.
There are a number of changes happening here. We're going to start with
the installation guide, which is simply moved to the appropriate
subdirectory.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-10 16:22:44 +00:00
Stephen Finucane
4fa7d6037c doc: Rework "install" document
This is a large rework of the installation guide. There are a couple of
changes necessary:

- 'Mac OSX' is replaced by 'macOS'
- PyPI installation steps are moved to their own section
- Instructions are no longer provided for installing Python on Windows:
instead, we refer to the other, better-maintained guides.

In addition, there are a number of cleanup items.

- Some paragraphs are reworded or clarified
- Semantic markup is added where possible
- Everything is wrapped to ~80 characters

A number of TODOs are inserted. These will be resolved separately.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-10 16:22:40 +00:00
Takeshi KOMIYA
85651bfdf2 Fix condition for deprecation warning 2018-02-10 23:36:25 +09:00
Takeshi KOMIYA
e84ba569a2 Merge branch '1.7-release' 2018-02-10 15:46:48 +09:00