Commit Graph

10250 Commits

Author SHA1 Message Date
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
Takeshi KOMIYA
2275c67966 io: Choose FileInput using `supported` attribute (refs: #4564) 2018-02-10 15:07:23 +09:00
Takeshi KOMIYA
e420d259d5 Update gitignore 2018-02-10 12:10:36 +09:00
Takeshi KOMIYA
506cc44d4a
Merge pull request #4571 from tk0miya/4560_i18n_compilation_problem
Fix i18n: message catalogs are not compiled when specific build (refs: #4560)
2018-02-10 12:08:26 +09:00
Takeshi KOMIYA
0f1168308b
Merge branch '1.7-release' into 4560_i18n_compilation_problem 2018-02-10 11:53:14 +09:00
Takeshi KOMIYA
9eff2a5679
Merge pull request #4585 from vedranmiletic/documentation-fixes
EXAMPLES: move Arcade to rtd section, add aria2
2018-02-10 11:31:01 +09:00
Vedran Miletić
7dc1b14b91 EXAMPLES: move Arcade to rtd section, add aria2 2018-02-10 01:06:03 +01:00
Takeshi KOMIYA
acee7b8a55
Merge pull request #4584 from Zac-HD/doctest
Report true file location of doctests
2018-02-09 22:12:55 +09:00
Zac-HD
b62628f678 Avoid misreporting line number 2018-02-09 11:05:26 +11:00
Zac-HD
68bccb01ac Get correct filename for each doctest block
This is complicated because doctests may be included from other files,
eg. dosctrings in a Python module.
2018-02-09 11:05:25 +11:00
Zac-HD
50823c4b37 Fix type hint, minor style improvements 2018-02-09 10:39:25 +11:00
Zac-HD
973f2680d6 Add ext.autodoc + ext.doctest test root 2018-02-09 10:39:25 +11:00
Takeshi KOMIYA
c21065e278
Merge pull request #4580 from tk0miya/remove_funcion_based_directive_tests
test: Remove function based directives
2018-02-08 21:50:14 +09:00
Takeshi KOMIYA
a9f370bc12 test: Remove function based directives 2018-02-08 13:50:25 +09:00
Takeshi KOMIYA
afbd27f996 Fix i18n: message catalogs are not compiled when specific build (refs: #4560)
sphinx-build skips message catalog builds if specific filename are given
as arguments.
2018-02-08 12:44:15 +09:00
Takeshi KOMIYA
acbf62fb6d
Merge pull request #4578 from dannguyen/patch-1
added "Hitchhiker's Guide to Python" to EXAMPLES
2018-02-08 11:56:08 +09:00
Dan Nguyen
678999fba2
added "Hitchhiker's Guide to Python" to EXAMPLES 2018-02-07 18:24:54 -08:00
Takeshi KOMIYA
c2cd4f6a40
Merge pull request #4566 from tk0miya/add_branch_models_to_contributing
docs: mention about branch model (refs: #4398)
2018-02-07 22:35:18 +09:00
Takeshi KOMIYA
fb257ac449 docs: mention about branch model (refs: #4398) 2018-02-07 22:14:18 +09:00
Takeshi KOMIYA
64945bc793
Merge pull request #4558 from tk0miya/refactor_application
Refactor application
2018-02-07 22:11:32 +09:00
Takeshi KOMIYA
533fa55936
Merge pull request #4561 from stephenfin/cleanup
Cleanup
2018-02-07 22:08:41 +09:00
Stephen Finucane
d35cda9943 util: Mark deprecated functions with warning
This ensures the functions can actually be removed as expected.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-07 11:26:59 +00:00
Takeshi KOMIYA
6edf175c91
Merge pull request #4570 from cocoatomo/unify-term
Unify expression of terms in the log message
2018-02-07 10:57:34 +09:00
cocoatomo
9b39e5e87f Unify expression of terms in the log message 2018-02-07 10:52:28 +09:00
Takeshi KOMIYA
7a92e3e409 Call git fetch before checking status 2018-02-07 10:49:46 +09:00
Takeshi KOMIYA
465eb05425
Merge pull request #4569 from cocoatomo/minor-typo
Insert a space after the comma in the message
2018-02-07 10:27:52 +09:00
cocoatomo
0be75fd029 Insert a space after the comma in the message 2018-02-07 10:23:43 +09:00
Takeshi KOMIYA
301aee4916 Drop function based directive support 2018-02-07 09:20:47 +09:00
Takeshi KOMIYA
51a0f709b5 Update sphinx.pot 2018-02-07 09:17:15 +09:00
Stephen Finucane
05f851fa19 trivial: Remove 'tests/etree13'
This vendored code had no callers in modern Sphinx and has not been
needed since Python 2.5, which included the ElementTree API [1], was
released. It can be removed in its entirety.

[1] https://docs.python.org/2/library/xml.etree.elementtree.html

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-02-06 20:15:25 +00:00
Takeshi KOMIYA
06a12db39b
Merge pull request #4567 from cocoatomo/translation-friendly-message
Make the log message more translation-friendly
2018-02-07 02:27:51 +09:00
cocoatomo
1c61bf6db4 More translation-friendly messages 2018-02-07 02:12:22 +09:00
cocoatomo
8969ae40de Make the log message more translation-friendly 2018-02-07 01:52:22 +09:00
Takeshi KOMIYA
94eae2c4f9 Add procedures for beta and final releases 2018-02-06 23:19:32 +09:00