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
11,826 Commits 2 Branches 219 Tags 163 MiB
2cbc921946
Commit Graph

11826 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
2cbc921946
Merge pull request #5650 from tk0miya/refactor_IndexEntry 
Add IndexEntry class to represent an entry of indices
 2018-11-21 11:09:54 +09:00
Takeshi KOMIYA
8491217553 Add IndexEntry class to represent an entry of indices 2018-11-21 10:02:45 +09:00
Takeshi KOMIYA
74f7689a70
Merge pull request #5651 from tk0miya/add_typehints_to_writers 
Add better type annotations to writers
 2018-11-21 10:00:24 +09:00
Takeshi KOMIYA
f128be573b Update type hints to text writer 2018-11-21 01:37:48 +09:00
Takeshi KOMIYA
42193dc581 Update type hints to texinfo writer 2018-11-21 01:37:48 +09:00
Takeshi KOMIYA
685dac96ca Update type hints to manpage writer 2018-11-21 01:37:48 +09:00
Takeshi KOMIYA
b3f085aa08 Update type hints to LaTeX writer 2018-11-21 01:37:48 +09:00
Takeshi KOMIYA
a608f7e725 Update type hints to HTML5 writer 2018-11-21 01:10:25 +09:00
Takeshi KOMIYA
c0f52fddd0 Update type hints to HTML4 writer 2018-11-21 01:10:12 +09:00
Takeshi KOMIYA
e46d14d506
Merge pull request #5649 from tk0miya/fix_annotations_latex_writer 
Fix type annotations for LaTeX writer
 2018-11-21 01:02:29 +09:00
Takeshi KOMIYA
d92fd2c787
Merge pull request #5638 from tk0miya/5385_master_doc_migrator 
Add a handler to migrate master_doc from "contents" to "index" (refs: #5385)
 2018-11-21 01:01:55 +09:00
Takeshi KOMIYA
1bd214b1a1
Merge pull request #5596 from cocoatomo/xrefrole-constructor 
Simplify XRefRole constructor
 2018-11-21 00:50:14 +09:00
Takeshi KOMIYA
1e700fa70c Add a handler to migrate master_doc from "contents" to "index" 2018-11-21 00:32:36 +09:00
Takeshi KOMIYA
5c6def439b
Merge pull request #5639 from stephenfin/text-writer-nits 
Fix two nits with the TextBuilder class
 2018-11-21 00:31:06 +09:00
Takeshi KOMIYA
34b690a577 Fix type annotations for LaTeX writer 2018-11-21 00:24:05 +09:00
Takeshi KOMIYA
5d2d4e0477
Merge pull request #5642 from jdufresne/typed 
Drop explicit dependency: typed_ast
 2018-11-20 23:14:37 +09:00
Takeshi KOMIYA
85dcb3d3e7
Merge pull request #5643 from stephenfin/doc-rework 
Doc rework (user guide, part 5)
 2018-11-20 23:03:48 +09:00
Stephen Finucane
1c07f0004f doc: Add "theming" to usage guide 
This one is a little unusual. The current theming doc mixes user-focused
documentation with developer-focused documentation. This is confusing
and unnecessary. Resolve the issue by splitting the doc in two. The
user-focused docs are moved to the advanced section of the usage guide,
while the developer docs remain where they are, pending the addition of
a developer guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 15:23:33 +01:00
Jon Dufresne
3bc938ceba Drop explicit dependency: typed_ast 
typed-ast has been a required dependency of mypy since v0.470. Can rely
on it being installed as a transient dependency and not list it
explicitly. For the change in mypy, see:

a207754a7e
 2018-11-16 05:23:56 -08:00
Stephen Finucane
356ebd5596 doc: Rework "theming" document 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:33:36 +01:00
Stephen Finucane
71e8477597 doc: Add "websupport" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:23:06 +01:00
Stephen Finucane
e766336a2b doc: Rework "websupport" documents 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:23:01 +01:00
Stephen Finucane
23afd29cbb doc: Add "setuptools" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:22:38 +01:00
Stephen Finucane
d380617c3b doc: Add "internationalization" to the usage guide 
This is added to the new "advanced" subsection.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 13:20:46 +01:00
Stephen Finucane
b7ff889050 doc: Rework "internationalization" document 
Shuffle some things around, add some additional markup, and fix header
styles.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 12:42:27 +01:00
Stephen Finucane
ac9f6a8b05 Fix two nits with the TextBuilder class 
- 'logger' was unused and can be removed
- 'TextTranslator.sectionchars' was overridden in '__init__' and doesn't
  need to be defined

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 11:15:05 +01:00
cocoatomo
212ecd203d Partially revert "Simplify XRefRole constructor" 2018-11-16 16:51:56 +09:00
Takeshi KOMIYA
6c94801ec2
Merge pull request #5621 from jdufresne/str-bytes 
Fix all BytesWarning identified through tests
 2018-11-14 20:05:48 +09:00
Takeshi KOMIYA
3a81caf148
Merge pull request #5631 from jdufresne/dict 
Always prefer dict literals over calls to dict()
 2018-11-14 20:04:12 +09:00
Takeshi KOMIYA
4fd14cf5e1
Merge pull request #5632 from jdufresne/super-json 
Use super() in SphinxJSONEncoder
 2018-11-14 20:02:04 +09:00
Takeshi KOMIYA
19b1078f6d
Merge pull request #5633 from jdufresne/js-test 
Improve JS handling in test_search.py
 2018-11-14 20:01:13 +09:00
Jon Dufresne
4cda774566 Improve JS handling in test_search.py 
- Reuse jsload() in all tests to reduce duplication.
- Fix -2 index to -1, to include the entire JSON string. Was previously
  chopping off the final '}'.
- Assert the serialized string ends with a closing parenthesis
 2018-11-13 21:25:46 -08:00
Jon Dufresne
8c46a94bca Use super() in SphinxJSONEncoder 
This case was missed as part of
710ca3d7c3.
 2018-11-13 21:22:30 -08:00
Jon Dufresne
1ae049b2ee Always prefer dict literals over calls to dict() 
Dict literals are always slightly faster and are idiomatic modern
Python.
 2018-11-13 18:44:16 -08:00
Jon Dufresne
41ad0d5347 Fix all BytesWarning identified through tests 
Code should not arbitrarily mix bytes & str values. The values should be
understood and deliberate. When Python is run with the -b option, this
change fixes warnings of the form:

  BytesWarning: str() on a bytes instance
 2018-11-13 18:08:49 -08:00
Takeshi KOMIYA
45ad2e41a5
Merge pull request #5610 from tk0miya/refactor_domains 
Refactor std domain: Add add_object() and add_program_option()
 2018-11-14 00:55:06 +09:00
Takeshi KOMIYA
c80b5fe58f
Merge pull request #5606 from sphinx-doc/fix_typehints3 
Fix type annotations for RoleFunction
 2018-11-14 00:53:28 +09:00
Takeshi KOMIYA
a6fc9259b0
Merge pull request #5620 from jdufresne/dep-force-decode 
Deprecate and drop internal use of force_decode()
 2018-11-14 00:47:41 +09:00
Jon Dufresne
555960d668 Deprecate and drop internal use of force_decode() 
In the Python 3 only code base, this function is no longer necessary.
The type of values is well understood and deliberate. Code should avoid
arbitrary mixing of bytes & str.

By removing force_decode() calls from docstring values, can deprecate
the now unused 'encoding' arguments to various autodoc methods.
 2018-11-13 07:16:39 -08:00
Takeshi KOMIYA
6b0e0fa3eb
Merge pull request #5613 from jdufresne/extras 
Simplify tox configuration with 'extras' option
 2018-11-13 22:41:17 +09:00
Takeshi KOMIYA
3abd705b35
Merge pull request #5626 from jdufresne/pycompat-u 
Deprecate sphinx.util.pycompat.u
 2018-11-13 22:38:16 +09:00
Takeshi KOMIYA
48e5b900ae
Merge pull request #5623 from jdufresne/comments 
Remove commented out dead code in sphinx/testing/util.py
 2018-11-13 21:52:05 +09:00
Takeshi KOMIYA
fddeab4c6d
Merge pull request #5624 from jdufresne/fix-ignore 
Correct type annotation to remove 'type: ignore' comment
 2018-11-13 21:50:08 +09:00
Takeshi KOMIYA
2f5b79b943
Merge pull request #5625 from jdufresne/unused 
Remove dead code `or '.'`
 2018-11-13 21:49:45 +09:00
Jon Dufresne
6fbf4a2f99 Deprecate sphinx.util.pycompat.u 
It is now simply a constant equal to the empty string. Provides no
further utility.
 2018-11-12 16:31:27 -08:00
Jon Dufresne
0137b0287a Remove dead code or '.' 
The expression `os.path.dirname(__file__)` always evaluates as a truthy
value. The `or '.'` is never evaluated.
 2018-11-12 14:31:29 -08:00
Jon Dufresne
1c9c9df68d Correct type annotation to remove 'type: ignore' comment 2018-11-12 13:26:21 -08:00
Jon Dufresne
88de460c43 Remove commented out dead code in sphinx/testing/util.py 
Commented since d47a7587f9 (Sep 21, 2014).
 2018-11-12 12:45:24 -08:00
Jon Dufresne
fc5aedd378 Simplify tox configuration with 'extras' option 
https://tox.readthedocs.io/en/latest/config.html#conf-extras

> extras(MULTI-LINE-LIST)
>
> New in version 2.4.
>
> A list of “extras” to be installed with the sdist or develop install.
> For example, extras = testing is equivalent to [testing] in a pip
> install command.
 2018-11-12 08:17:22 -08:00
Takeshi KOMIYA
b6fb808317
Merge pull request #5481 from jdufresne/binary-type 
Remove use of six.binary_type; use bytes instead
 2018-11-12 22:44:59 +09:00