IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
9,899 Commits 2 Branches 219 Tags 163 MiB
32c5e8346f
Commit Graph

9899 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
32c5e8346f Close #4460: extensions should return the version of data structure as metadata 2018-01-25 02:04:22 +09:00
Takeshi KOMIYA
f886f08cb2 Merge branch '1.7-release' 2018-01-25 02:02:15 +09:00
Takeshi KOMIYA
0a82ba00b5 Fix packaging module can't handle 3.7.0a4+ correctly 2018-01-25 01:44:24 +09:00
Takeshi KOMIYA
e01d076443 Fix Signature does not work correctly with py37a4+ 2018-01-25 00:56:26 +09:00
Takeshi KOMIYA
9340a45393 test: Don't use os.errno. Use errno directly 2018-01-25 00:48:37 +09:00
Takeshi KOMIYA
f779fa7ad6 Merge branch 'stable' into 1.7-release 2018-01-25 00:40:21 +09:00
Takeshi KOMIYA
78434992f7
Merge pull request #4488 from tk0miya/workaround_for_py37a4+ 
test: Add workaround for python 3.7.0a4+
 2018-01-25 00:37:23 +09:00
Takeshi KOMIYA
ded638c82b test: Add workaround for python 3.7.0a4+ 
Since 3.7.0a+, the behavior of typing module has been changed.
As a result, format_annotation() also has been changed.
 2018-01-25 00:02:49 +09:00
Takeshi KOMIYA
cfd9528879
Merge pull request #4466 from kurtmckee/update-install-docs 
Update install docs
 2018-01-22 00:12:17 +09:00
Takeshi KOMIYA
16ad6429d0
Merge pull request #4468 from stephenfin/doc-restructure 
Doc restructure (continued)
 2018-01-21 23:42:11 +09:00
Takeshi KOMIYA
24a4eab038
Merge pull request #4473 from tk0miya/4472_lost_documentation_options 
Fix #4472: DOCUMENTATION_OPTIONS is not defined
 2018-01-21 22:11:56 +09:00
Takeshi KOMIYA
0e5934b9ff Fix #4472: DOCUMENTATION_OPTIONS is not defined 2018-01-21 21:02:07 +09:00
Stephen Finucane
1ec03ec1b0 doc: Add 'deprecated' directive to docstrings 
This helps emphasize the deprecated nature of these directives.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:38:03 +00:00
Stephen Finucane
487480ca01 doc: Add 'is_parallel_allowed' 
This is an important function and should be documented.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:37:59 +00:00
Stephen Finucane
6c23dac5a6 doc: Reorder 'sphinx.application' docs to match code 
Use the same ordering to minimize cognitive load.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:52 +00:00
Stephen Finucane
b7ff955472 doc: Move 'sphinx.application' API docs to code 
This allows us to do something like 'help(sphinx.application)' in code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:46 +00:00
Stephen Finucane
eaaab75ec2 doc: Rework 'sphinx.application' API documentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 10:49:38 +00:00
Takeshi KOMIYA
9a3f401c46 Merge branch '1.7-release' 2018-01-21 16:07:14 +09:00
Takeshi KOMIYA
91873f09b8 Merge branch 'stable' into 1.7-release 2018-01-21 16:06:14 +09:00
Takeshi KOMIYA
6e420e517e
Merge pull request #4465 from tk0miya/improve_config 
Improve config
 2018-01-21 16:05:34 +09:00
Takeshi KOMIYA
8b0e088711
Merge pull request #4425 from tk0miya/sphinx-build-set-proc-count-to-cpu-count 
sphinx-build: Add support for "-j auto"
 2018-01-21 16:05:00 +09:00
Takeshi KOMIYA
944047c8d4 Emit config-inited just after config.init_values() 2018-01-21 15:44:37 +09:00
Takeshi KOMIYA
eaa44779d5
Merge branch '1.7-release' into sphinx-build-set-proc-count-to-cpu-count 2018-01-21 15:43:17 +09:00
Takeshi KOMIYA
0a04f346a3 Fix mypy violations 2018-01-21 13:21:55 +09:00
Takeshi KOMIYA
a924fc13b4 Update CHANGES for PR #4467 2018-01-21 13:20:16 +09:00
Aaron Carlisle
e77ca75103 Update test file 2018-01-21 13:18:29 +09:00
Aaron Carlisle
ccd70c3b89 Update scrolls theme 2018-01-21 13:18:29 +09:00
Aaron Carlisle
ade1a49ed1 Themes: Rename 'csss' block to 'css' 
Was a mistake in 618ef6492c
 2018-01-21 13:18:29 +09:00
Takeshi KOMIYA
1c3865b190
Merge pull request #4469 from kurtmckee/use-https-urls 
Use HTTPS URL's
 2018-01-21 13:11:12 +09:00
Takeshi KOMIYA
7efb82046b
Merge pull request #4464 from stephenfin/issue/4451 
doc: Resolve inconsistent 'sphinx-apidoc' docs
 2018-01-21 12:20:47 +09:00
Kurt McKee
7775b9e1ce Add "Kurt McKee" to the AUTHORS file 2018-01-20 21:20:10 -06:00
Kurt McKee
cd6c88dc0e Convert in-code HTTP URL's to HTTPS, including examples 2018-01-20 21:20:09 -06:00
Takeshi KOMIYA
e114adc53f
Merge pull request #4471 from stephenfin/issue/4470 
sphinx: Call 'sphinx.cmd.build.main' function
 2018-01-21 12:05:21 +09:00
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