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
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