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
17,493 Commits 2 Branches 219 Tags 163 MiB
356f7c53e2
Commit Graph

139 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA
78d407cf83 Update CHANGES for PR #8404 2020-11-14 18:55:25 +09:00
François Freitag
683635f5b4 linkcheck: Remove call to is_ssl_error() 
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
 2020-11-12 19:58:04 +01:00
Takeshi KOMIYA
bbcd471557 Merge branch '3.x' 2020-11-09 02:50:08 +09:00
Takeshi KOMIYA
6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect 
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
 2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter 
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
 2020-10-04 13:50:10 +09:00
Takeshi KOMIYA
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00
Takeshi KOMIYA
5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file 
This postpones the evaluation of LaTeX packages via
``app.add_latex_package()`` to just before writing .tex file.  That
allows extensions to add LaTeX packages during reading and resolving
phase.
 2020-09-21 01:01:49 +09:00
Takeshi KOMIYA
a8927bcd3e Merge branch '3.x' 2020-08-08 18:16:59 +09:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members 
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names 
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
 2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
9969239b22 Merge branch '3.x' 2020-08-01 18:08:23 +09:00
Takeshi KOMIYA
e98f39d21d Fix #7993: texinfo: TypeError is raised for nested object descriptions 
The texinfo writer remembers the current desc node to render
a desc_annotation node.  This makes the mechanism robust to support
nested object descriptions.
 2020-07-25 22:57:12 +09:00
Takeshi KOMIYA
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
891c659ced Deprecate sphinx.util:rpartition() 2020-05-09 22:00:04 +09:00
Takeshi KOMIYA
75203967d8 Merge branch '3.x' 2020-05-04 00:15:20 +09:00
Takeshi KOMIYA
1ba671a677 Deprecate ignore parameter for Documenter.get_doc() 2020-05-03 01:59:47 +09:00
Takeshi KOMIYA
42aa293679 Merge branch '3.x' 2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
e5192ba48b refactor: AutosummaryRender 2020-04-25 01:25:00 +09:00
Takeshi KOMIYA
0374d217d4 refactor: Deprecate unused parameters 2020-04-23 22:54:53 +09:00
Takeshi KOMIYA
931bfcca88 refactor: autosummary: Change first argument for AutosummaryRenderer 2020-04-23 22:51:23 +09:00
Takeshi KOMIYA
61b823ad10 refactor: Deprecate unused parameters 2020-04-23 02:25:58 +09:00
Takeshi KOMIYA
1aca70cf80 Merge branch '3.x' 2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
53f0d4e646 Deprecate: The module argument of find_autosummary_in_docstring() 2020-04-12 18:14:16 +09:00
Takeshi KOMIYA
90fb44ee43 Merge branch '3.x' 2020-03-23 00:07:51 +09:00
Takeshi KOMIYA
fe3782d2ed Deprecate sphinx.ext.autosummary:process_autosummary_toc() 
The handler searches autosummary_toc node under root of document and
just under section nodes.  But that is already done in
ToctreeCollector.process_doc().  So it's no longer needed.
 2020-03-21 21:44:59 +09:00
Takeshi KOMIYA
c7e590818a Merge branch '3.x' 2020-03-21 17:53:22 +09:00
Takeshi KOMIYA
2202bff6b2 Deprecate sphinx.ext.autodoc.get_documenters() 2020-03-16 01:58:02 +09:00
Takeshi KOMIYA
d0cff3b4fc Deprecate sphinx.util.pycompat.execfile_() 2020-03-16 01:41:58 +09:00
Takeshi KOMIYA
e116613a3a Merge branch '3.x' 2020-03-10 01:15:52 +09:00
Takeshi KOMIYA
d49bec1c67 py domain: Deprecate PyDecoratorMixin 2020-03-07 23:13:06 +09:00
Takeshi KOMIYA
3e0618ba3a Deprecate codes for docutils-0.13 or 0.14 2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
a13ec4f41c Support LaTeX Theming; a set of document class settings (refs: #6672) 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
2b70875f6a Merge branch 'drop_desc_signature_first' into 3.x 2020-02-22 17:39:56 +09:00
Takeshi KOMIYA
5648b2eb88 Deprecate DescDirective 2020-02-22 12:15:20 +09:00
Takeshi KOMIYA
379f52badf
Merge pull request #7154 from tk0miya/deprecate_Parser.app 
Deprecate sphinx.parsers.Parser.app
 2020-02-16 22:19:22 +09:00
Takeshi KOMIYA
9409db0771 Deprecate sphinx.parsers.Parser.app 2020-02-15 00:39:34 +09:00
Takeshi KOMIYA
baf4c7df23 Deprecate sphinx.util.inspect.getargspec() 2020-02-14 12:08:52 +09:00
Takeshi KOMIYA
6e0119526a Merge branch '2.0' 2020-02-09 16:21:32 +09:00
Takeshi KOMIYA
df3c0448dd Deprecate desc_signature['first'] 2020-02-09 00:58:42 +09:00
Takeshi KOMIYA
dee8b9eddb Fix #6327: apidoc: Support a python package consisted of __init__.so file 2020-02-08 18:11:48 +09:00
Takeshi KOMIYA
9d301e5b81 refactor: apidoc.shall_skip() 2020-02-08 17:59:29 +09:00
Takeshi KOMIYA
7d6374d983 testing: Add Path.read_text() and Path.read_bytes() 
To migrate pathlib.Path in future, compatibile methods are needed
for our Path class.
 2020-02-01 11:45:47 +09:00
Takeshi KOMIYA
41032572a5 Merge branch '2.0' 2020-02-01 11:17:03 +09:00
Takeshi KOMIYA
b73cc5652a Update deprecation list 2020-01-31 01:59:24 +09:00
Takeshi KOMIYA
52afc79e1f Merge branch '2.0' into refactor_latex 2020-01-31 01:18:57 +09:00
Takeshi KOMIYA
e7a0af807a Merge branch '2.0' 2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
045630ec85 Deprecate sphinx.util.inspect:safe_getmembers() 2020-01-25 23:21:33 +09:00
Takeshi KOMIYA
cad1f86dd8 Merge branch '2.0' 2020-01-11 02:56:58 +09:00
Takeshi KOMIYA
5867416612 refactor: Add sphinx.util.inspect.signature() 
As a successor of sphinx.util.inspect.Singnature, this adds
signature() function behaves like `inspect.signature()`.  It is
very similar to way of python's inspect module.

In addition, this also adds stringify_annotation() helper to
sphinx.util.inspect module.  With these two functions, we can move
to python's Signature object to represent function signatures
perfectly.  It's natural design for python developers than ever.
 2020-01-09 00:32:07 +09:00
Takeshi KOMIYA
af2a3c0dde Merge branch '2.0' 2020-01-08 01:37:53 +09:00
Takeshi KOMIYA
05daa3c7ce Add sphinx.util.typing:stringify() to represent annotations as string 2020-01-05 01:13:27 +09:00
Takeshi KOMIYA
7123f4038a Fix #6559: Wrong node-ids are generated in glossary directive 2020-01-02 22:03:39 +09:00
Takeshi KOMIYA
e628afd5cd Merge branch '2.0' 2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
c358e04b09 Close #6558: glossary: emit a warning for duplicated glossary entry 2019-12-29 22:31:36 +09:00
Takeshi KOMIYA
8dc3315ce5 Deprecate sphinx.roles:Index and make a copy to sphinx.domains.index 2019-12-29 19:12:58 +09:00
Takeshi KOMIYA
4f83793fd0 Move sphinx.directives.other:Index to sphinx.domains.index 2019-12-29 18:21:26 +09:00
Takeshi KOMIYA
ff9e5e6dbd doc: Sort deprecated list alphabetically 2019-12-28 19:37:43 +09:00
Takeshi KOMIYA
3ddbd73f49 refactor: latex: Deprecate settings.* attributes based on latex_documents 2019-12-27 22:46:16 +09:00
Takeshi KOMIYA
c8074b4a5d Deprecate sphinx.util:detect_encoding() and ModuleAnalyzer.encoding 2019-12-27 22:08:32 +09:00
Takeshi KOMIYA
7581ee1084 Deprecate sphinx.util:get_module_source() 2019-12-27 01:57:39 +09:00
Takeshi KOMIYA
6d6fe9da0d Add IndexDomain 2019-12-22 17:20:35 +09:00
Takeshi KOMIYA
00c30679cf Deprecate sphinx.io.FiletypeNotFoundError and get_filetype() 2019-12-16 01:45:02 +09:00
jfbu
30b26dd6a1 LaTeX: avoid quotes and TeX ligature replacements in PDF output 
Refs: #6890

The comma character is not TeX-escaped because it is frequent in general
text and escaping it would make the LaTeX output larger for only dealing
with the problem of the LaTeX-ligature of ,, into a single character.
And one there is problem with the commas in options to Verbatim from
PygmentsBridge.

The hyphen character is escaped (not in ids and URIs!) to
\sphinxhyphen{} for both Unicode and non-Unicode engines. This is needed
to work around hyperref transforming -- and --- from section titles into
EN DASH resp. EM DASH in PDF bookmarks.

https://github.com/latex3/hyperref/issues/112

Note to expert LaTeX users: if Sphinx latex user with xelatex has

- turned off Smart Quotes for some reason,

- but does want TeX ligatures and thus overrode Sphinx
latex_elements['fontenc'] default (since #6888) to this effect,

then this should be added to LaTeX preamble:

    \def\sphinxhyphen#1{-}% (\protected is now not needed)
    \let\sphinxhyphenforbookmarks\sphinxhyphen
 2019-12-15 14:19:50 +01:00
Takeshi KOMIYA
f3469bcc8f Make escape() and hlescape() as public APIs of texescape 2019-11-16 19:42:06 +09:00
Takeshi KOMIYA
5f559fbb98 Deprecate sphinx.util.texescape.tex_escape_map 2019-11-16 18:34:48 +09:00
Takeshi KOMIYA
399f773d9d gettext: Use template file to generate message catalog 2019-11-08 00:36:57 +09:00
Takeshi KOMIYA
21cd1c2ef5 refactor: SphinxStandaloneReader should not hold an application object 2019-08-20 21:45:50 +09:00
Takeshi KOMIYA
564d23be7a
Merge pull request #6467 from tk0miya/refactor_math 
refactor: Add data accessors to MathDomain
 2019-06-15 23:48:57 +09:00
Takeshi KOMIYA
9b0f415e21 refactor: Add data accessors to MathDomain 2019-06-15 23:05:45 +09:00
Takeshi KOMIYA
f6dfab33d2
Merge branch '2.0' into refactor_todo2 2019-06-15 16:45:17 +09:00
Takeshi KOMIYA
649ebea438 autosummary: deprecate info and warn arguments for generate_autosummary_docs() 2019-06-10 13:45:28 +09:00
Takeshi KOMIYA
8fd817d174 refactor: todo: Add TodoListProcessor to expand todolist nodes 2019-06-03 00:17:29 +09:00
Takeshi KOMIYA
9abb4820b1 refactor: todo: Add TodoDomain to collect todo nodes 2019-06-02 23:41:39 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
7c8b1ad900 refactor: apidoc: Replace makename() by module_join() 2019-05-15 00:18:00 +09:00
Takeshi KOMIYA
fa560ebf95 apidoc: Deprecate unused functions 2019-05-04 18:42:22 +09:00
Jon Dufresne
ee23a29b3c Deprecate EpubBuilder.esc() in favor of stdlib html.escape() 
Available since Python 3.2.

https://docs.python.org/3/library/html.html#html.escape
 2019-04-23 19:34:55 -07:00
Takeshi KOMIYA
aabeb71123 imgmath: Use template file for LaTeX 2019-04-16 01:38:31 +09:00
Takeshi KOMIYA
6af3896103 Add PyFunction and PyVariable; directives for python functions and variables 2019-04-13 20:26:07 +09:00
Takeshi KOMIYA
b0b3f5a677 deprecate PyClassmember class 2019-04-07 22:41:10 +09:00
Takeshi KOMIYA
452e5dcf21 Deprecate StandardDomain.process_*() 2019-04-06 14:14:18 +09:00
Takeshi KOMIYA
885d35e374 Add CitationDomain for citation processing 2019-03-30 23:12:08 +09:00
Takeshi KOMIYA
87c6335b46 Move transforms for citations to sphinx.domains.citation 2019-03-30 20:31:10 +09:00
Takeshi KOMIYA
a990f9ff72 Add ObjectDescription.get_field_type_map() 
Conceal caching mechanism of Field classes to ObjectDescription class.
This deprecates DocFieldTransformer.preprocess_field_types().
 2019-03-23 17:27:22 +09:00
Takeshi KOMIYA
86d5d2113e Deprecate imports for compatibility 2019-03-17 18:30:50 +09:00
Takeshi KOMIYA
b5959ca230
Add SphinxPostTransform class (#6154) 
* Add SphinxPostTransform

* Apply SphinxPostTransform to latex transforms
 2019-03-17 18:27:00 +09:00
Takeshi KOMIYA
d4ac7217a8 Move list of deprecated API to extdev/deprecated.rst 2019-03-09 19:32:24 +09:00