Stephen Finucane
ecbe08d467
sphinx: Call 'sphinx.cmd.build.main' function
...
This was missed in commit '89f9c7cab'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes : #4470
2018-01-20 23:19:38 +00:00
Stephen Finucane
78a44b5825
doc: Resolve inconsistent 'sphinx-apidoc' docs
...
The signature for the 'sphinx-apidoc' call differs between the man page
and the output of 'sphinx-apidoc --help'. Resolve this by considering
the 'sphinx-apidoc --help' output the canonical reference.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes : #4451
2018-01-20 23:02:18 +00:00
Kurt McKee
beefd445c1
Convert doc HTTP links to HTTPS, even in documentation examples
...
A small number of URL's redirected, or were stale but had obvious
alternatives. These have been updated. For example, a Google style
guide for Python was no longer available at googlecode.com, and
Paver docs are now at readthedocs.io.
2018-01-20 16:50:35 -06:00
Kurt McKee
c0ffcba9e2
Update the screenshots and docs to match the Python website and installer
...
The instructions for installing pip are no longer relevant and have
been removed. The instructions for modifying the PATH are no longer
relevant and have been removed. The final section, "Installing Sphinx
with pip", is now a subsection of the Windows install instructions.
The verb tense has been modified to match the rest of the instructions.
The command line examples have been converted to use the Pygments text
lexer instead of the batch lexer, which highlights everything after `>`
incorrectly.
2018-01-20 10:07:56 -06:00
Takeshi KOMIYA
3413590edd
Merge pull request #4436 from stephenfin/directory-validation
...
app: Centralize directory validation
2018-01-21 01:02:45 +09:00
Kurt McKee
3620d85b80
Update the Sphinx version to 1.6
2018-01-20 09:59:50 -06:00
Takeshi KOMIYA
3431955edf
Merge pull request #4278 from stephenfin/doc-restructure
...
Doc restructure
2018-01-21 00:59:21 +09:00
Kurt McKee
f70fcabb7c
Update the MacPorts URL to use HTTPS
2018-01-20 09:57:28 -06:00
Takeshi KOMIYA
c80a26c81b
refactor: move source_suffix migrator to event handler
2018-01-20 22:30:37 +09:00
Takeshi KOMIYA
eda09a717a
Add `sphinx.config.Any
` to represent the config value accepts any type of values
2018-01-20 22:30:37 +09:00
Takeshi KOMIYA
fa385f908e
latex: Use config-inited event for validation
2018-01-20 22:30:36 +09:00
Stephen Finucane
30b7f3f4d6
setuptools: Don't create directories
...
Don't create the build or doctree directories. These are already handled
by 'sphinx.application.Application' and 'sphinx.builder.Builder',
respectively.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 13:05:06 +00:00
Stephen Finucane
3a85b3502f
app: Centralize directory validation
...
This allows us to avoid duplication of code and ensure validation
happens regardless of who's initializing the class. We introduce a new
exception - ApplicationError - to indicate these kinds of issues. This
subclasses SphinxError, meaning we don't need to modify our exception
handling code.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 13:04:29 +00:00
Stephen Finucane
b215f523f7
doc: Move sphinx.logging API docs to code
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 13:00:43 +00:00
Takeshi KOMIYA
70aa784f51
Merge pull request #4462 from tk0miya/use_event_role
...
doc: Use :event: role
2018-01-20 21:58:53 +09:00
Stephen Finucane
b7749c6ca3
doc: Move sphinx.config API docs to code
...
Once again, we make things a little smarter by using Python domain
roles.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 12:53:45 +00:00
Stephen Finucane
391cd8195b
doc: Move sphinx.errors API docs to code
...
This allows us to do something like 'help(sphinx.errors)' in code. We
reword the exception descriptions per Python stdlib conventions.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 12:47:49 +00:00
Takeshi KOMIYA
17c2647676
Drop autofilling metadata feature for rst2pdf
2018-01-20 21:34:57 +09:00
Takeshi KOMIYA
a331e90c87
doc: Remove mentions to rst2pdf
2018-01-20 21:33:09 +09:00
Takeshi KOMIYA
29df3a095a
Add config-inited event
2018-01-20 21:21:45 +09:00
Takeshi KOMIYA
6770c6ae67
doc: Use :event: role
2018-01-20 21:18:54 +09:00
Takeshi KOMIYA
ae620e16f7
doc: Fix typo
2018-01-20 21:09:51 +09:00
Takeshi KOMIYA
38966ba89d
Merge pull request #4461 from tk0miya/4434_number_label_is_considered_as_invalid
...
Fix #4434 : pure numbers as link targets produce warning
2018-01-20 20:20:21 +09:00
Takeshi KOMIYA
28b07c4f91
Bump version
2018-01-20 19:48:37 +09:00
Takeshi KOMIYA
896ab3a2f5
Fix #4434 : pure numbers as link targets produce warning
2018-01-20 19:43:43 +09:00
jfbu
382f8aeb6a
Merge branch '1.7-release'
2018-01-20 10:49:21 +01:00
jfbu
d2d31e2e7d
Fix failed latex test after merge
2018-01-20 10:48:27 +01:00
jfbu
02ee4ec86b
Merge branch 'stable' into 1.7-release
2018-01-20 10:38:03 +01:00
Jean-François B
d3058f462d
Merge pull request #4452 from jfbu/4431_fix
...
Fix "Undefined control sequence \\hlineSomeText" (#4431 ; refs: #3435 )
2018-01-20 10:23:03 +01:00
Takeshi KOMIYA
fa215ea341
Merge pull request #4184 from skirpichev/fix-2437
...
autodoc: make full reference for classes, aliased with "alias of"
2018-01-20 17:08:34 +09:00
Takeshi KOMIYA
e8da18d88d
Merge pull request #4458 from tk0miya/refactor_i18n_reader
...
Drop unused method; LoggingReporter.set_source()
2018-01-20 16:59:19 +09:00
Takeshi KOMIYA
158d98cc1e
Fix flake8 violation
2018-01-20 16:18:38 +09:00
Takeshi KOMIYA
a78f66a1d3
Merge branch 'stable' into fix-2437
2018-01-20 16:16:20 +09:00
Takeshi KOMIYA
fda7c88ec3
Drop unused method; LoggingReporter.set_source()
2018-01-20 16:09:15 +09:00
Takeshi KOMIYA
020c51532b
Merge branch '1.7-release'
2018-01-20 11:02:42 +09:00
Takeshi KOMIYA
d1d55eb35f
Fix broken test
2018-01-20 10:54:53 +09:00
Takeshi KOMIYA
20a6cb6240
mathbase: Remove unused data
2018-01-20 02:24:34 +09:00
Takeshi KOMIYA
3b28aadba9
Merge branch '1.7-release'
2018-01-20 02:22:48 +09:00
Takeshi KOMIYA
8b8c3d1736
Merge branch 'stable' into 1.7-release
2018-01-20 02:22:35 +09:00
Takeshi KOMIYA
80a4b272ad
Merge pull request #4455 from tk0miya/4415_inherited_classmethod
...
4415 inherited classmethod
2018-01-20 02:15:04 +09:00
Takeshi KOMIYA
295323d5aa
Fix #4415 : autodoc classifies inherited staticmethods as regular methods
2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
cbb10d61f7
Fix #4415 : autodoc classifies inherited classmethods as regular methods
2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
2b89f72d54
Merge pull request #4457 from tk0miya/4438_invalid_math_label
...
Fix #4438 : math: math with labels with whitespace cause html error
2018-01-20 00:33:44 +09:00
Takeshi KOMIYA
f91c732749
Fix #4438 : math: math with labels with whitespace cause html error
2018-01-19 23:13:21 +09:00
Takeshi KOMIYA
f9a53f50c6
Merge pull request #4453 from tk0miya/4412_upgrade_jquery
...
Fix #4412 : Updated jQuery version from 3.1.0 to 3.2.1
2018-01-19 20:20:41 +09:00
Takeshi KOMIYA
357fba4467
Fix #4412 : Updated jQuery version from 3.1.0 to 3.2.1
2018-01-19 14:45:11 +09:00
jfbu
9aca29a781
Fix "Undefined control sequence \\hlineSomeText" ( #4431 ; refs: #3435 )
2018-01-18 15:35:59 +01:00
Takeshi KOMIYA
a1f13e3000
Merge pull request #4442 from deoren/sphinx-quickstart-typo
...
Fix (very) minor typo in sphinx-quickstart man page
2018-01-18 00:01:24 +09:00
deoren
c808b4b8db
minor typo
2018-01-16 15:09:45 -06:00
Takeshi KOMIYA
487c9feebf
Update CHANGES
2018-01-17 00:04:12 +09:00