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,912 Commits 2 Branches 219 Tags 163 MiB
8f2540d4d2
Commit Graph

9912 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
8f2540d4d2 Merge branch '1.7-release' 2018-01-28 00:18:48 +09:00
Takeshi KOMIYA
af25fa123d Merge branch 'stable' into 1.7-release 2018-01-28 00:18:33 +09:00
Takeshi KOMIYA
6897b80fc4 Update CHANGES for PR #4491 2018-01-27 22:08:54 +09:00
Takeshi KOMIYA
6a0e83904a
Merge pull request #4491 from Emantor/fix/autodoc_mock_importer 
autodoc: prefer _MockImporter over other importers in sys.meta_path
 2018-01-27 22:05:30 +09:00
Rouven Czerwinski
bcdea4da5c autodoc: prefer _MockImporter over other importers in sys.path 
In case we want to mock modules which are actually available in the current
environment, we need to add the _MockImporter before other importers. We ran
into this problem in our application, where importing the existing modules
caused side effects which were not fixed by autodoc_mock_imports.
 2018-01-27 13:51:00 +01:00
Takeshi KOMIYA
2b56d70423
Merge pull request #4485 from tk0miya/drop_hack_for_py31 
Drop a hack for py31
 2018-01-25 10:45:49 +09:00
Takeshi KOMIYA
3b42c8e06c Drop a hack for py31 2018-01-25 02:02:54 +09:00
Takeshi KOMIYA
f886f08cb2 Merge branch '1.7-release' 2018-01-25 02:02:15 +09:00
Takeshi KOMIYA
376b6a597d
Merge pull request #4489 from tk0miya/1.7-release 
workaround for typing module in py370a4+
 2018-01-25 02:02:04 +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
b6efff7990 Update CHANGS for PR #4449 2018-01-25 01:18:02 +09:00
Takeshi KOMIYA
068bbb1b8a
Merge pull request #4449 from dhellmann/stable-fix-autodoc-for-empty-packages 
fix ext.apidoc to include "empty" packages that contain modules
 2018-01-25 01:15:36 +09:00
Takeshi KOMIYA
af96f79456
Merge pull request #4480 from tk0miya/4477_invalid_buildinfo_file 
Fix #4477: Build fails after building specific files
 2018-01-25 01:14:26 +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
467c2d7cb7 Merge branch 'stable' into 4477_invalid_buildinfo_file 2018-01-25 00:38:03 +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
1591607481 Fix #4477: Build fails after building specific files 2018-01-24 21:28:06 +09:00
Doug Hellmann
83f30712b8 fix ext.apidoc to include "empty" packages that contain modules 
Commit 2d99648e99 changed the apidoc
extension to ignore packages if the __init__.py file was empty. That
breaks the toctree structure if those packages do contain submodules
and subpackages. This patch adds a check to ensure that empty
__init__.py modules are only skipped if there are no other python
modules in the same directory.

Addresses bug #654

Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 2018-01-23 14:21:03 -05: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