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
15,035 Commits 2 Branches 219 Tags 163 MiB
a5cba8cdbb
Commit Graph

382 Commits

Author SHA1 Message Date
Takeshi KOMIYA
712c20a3d9 Merge branch '2.0' 2019-12-16 00:05:35 +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
15c266c445 Merge branch '2.0' 2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
6644830941 Merge branch '2.0' 2019-11-17 14:24:04 +09: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
e8925e78ca Merge branch '2.0' 2019-10-06 18:41:32 +09:00
Takeshi KOMIYA
21cd1c2ef5 refactor: SphinxStandaloneReader should not hold an application object 2019-08-20 21:45:50 +09:00
Takeshi KOMIYA
b325a1de2b Merge branch '2.0' 2019-06-21 12:47:02 +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
5d42659e33 Merge branch '2.0' 2019-06-15 23:39:44 +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
ce3c5735cd Merge branch '2.0' 2019-06-01 01:45:47 +09:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
b9d7239d90 Merge branch '2.0' 2019-05-29 00:51:25 +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
f63abac2ca Merge branch '2.0' 2019-05-13 22:03:26 +09:00
Takeshi KOMIYA
fa00458f4f docs: Fold lines by 80 chars 2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
37a5736a1f Merge branch '2.0' 2019-05-06 21:09:43 +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
jfbu
65ac90773d Merge branch '2.0' 2019-04-23 14:48:17 +02:00
Takeshi KOMIYA
e9e8fd264b
Merge pull request #6308 from tk0miya/imgmath_template 
imgmath: Use template file for LaTeX
 2019-04-19 13:13:37 +09:00
Takeshi KOMIYA
06f86b0639 Make EventManager portable 
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
 2019-04-16 14:06:36 +09:00
Takeshi KOMIYA
15bc5a32bb
Merge pull request #6260 from tk0miya/refactor_events 
Make EventManager portable
 2019-04-16 14:04:54 +09:00
Takeshi KOMIYA
aabeb71123 imgmath: Use template file for LaTeX 2019-04-16 01:38:31 +09:00
Takeshi KOMIYA
efc3405c6f Merge branch '2.0' 2019-04-14 19:35:33 +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
df05d9254d Merge branch '2.0' 2019-04-07 19:29:52 +09:00
Takeshi KOMIYA
9e2aba54d3 Make EventManager portable 
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
 2019-04-06 15:36:50 +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
61098a0ae2 Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +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
2606002bb4
Merge pull request #6125 from tk0miya/doc-enhance_extension_dev_i18n 
doc: Enhance documentation about internalization of external extension (refs: #5991)
 2019-03-10 01:16:06 +09:00
Takeshi KOMIYA
d4ac7217a8 Move list of deprecated API to extdev/deprecated.rst 2019-03-09 19:32:24 +09:00
Takeshi KOMIYA
4ca5924d49
Merge pull request #6129 from tk0miya/refactor_util.nodes 
Refactor util.nodes
 2019-03-07 01:20:06 +09:00
Takeshi KOMIYA
259c2bb8a6 refactor: Rename find_source_node() to get_node_source() 2019-03-03 14:42:23 +09:00
Takeshi KOMIYA
b3b5a595a9 docs: Update docs for i18n 2019-03-02 19:45:42 +09:00
Takeshi KOMIYA
4b15b6659f Move ext-i18n section to extdev/i18n.rst 2019-03-02 19:04:24 +09:00
Takeshi KOMIYA
ea1eec75dc Merge branch 'master' into doc-enhance_extension_dev_i18n 2019-03-02 19:00:25 +09:00
Takeshi KOMIYA
0d7bc86e7b refactor: move NoUri to sphinx.errors 2019-03-02 16:21:44 +09:00
Takeshi KOMIYA
8d0d75fea7
Merge pull request #6110 from tk0miya/refactor_catalog 
Refactor catalog detection and compilation
 2019-02-27 23:36:14 +09:00
Takeshi KOMIYA
fb8838ee53 refactor: Use CatalogRepository instead of find_catalog_source_file() 2019-02-27 22:47:08 +09:00
Takeshi KOMIYA
5f8f902b63 Rename find_catalog() to docname_to_domain() 2019-02-27 21:44:16 +09:00
Takeshi KOMIYA
af51e9825a refactor: Move implementation of mock to sphinx.ext.autodoc.mock 2019-02-27 21:42:23 +09:00
Takeshi KOMIYA
19b52c6eaa Replace :autolink: roles by class based implementation 2019-02-27 16:02:49 +09:00
Takeshi KOMIYA
1ca210aab1 Separate json and pickle to sphinxcontrib package 2019-02-17 22:31:50 +09:00
Takeshi KOMIYA
3ec032fa39 Replace :file: and :samp: roles by class based implementation 2019-02-16 12:37:46 +09:00
Takeshi KOMIYA
ea4d8ca08d Replace :guilabel: and :menuselection: roles by class based implementation 2019-02-16 02:30:28 +09:00
Takeshi KOMIYA
065ece6f4c docs: Add SphinxRole and ReferenceRole 2019-02-16 01:55:46 +09:00
Takeshi KOMIYA
9cb40436ed Replace :pep: and :rfc: roles by class based implementation 2019-02-16 00:34:24 +09:00
Takeshi KOMIYA
a6d345f95d Replace :index: role by class based implementation 2019-02-16 00:05:13 +09:00
Takeshi KOMIYA
3b49f9fe3d Separate htmlhelp to sphinxcontrib package 2019-02-15 01:44:32 +09:00
Takeshi KOMIYA
549a763195
Merge pull request #6025 from tk0miya/refactor_roles2 
Introduce SphinxRole class as a base class of roles
 2019-02-14 01:09:28 +09:00
Takeshi KOMIYA
2efc1065c0 Deprecate sphinx.util.pycompat:sys_encoding 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
b25deb259e refactor: Move NoneType to sphinx.util.typing 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
d40ce68c7b refactor: Move terminal_safe() to sphinx.util.console 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
ac70a4dd91 Replace :abbr: role by class based implementation 2019-02-06 01:20:58 +09:00
Takeshi KOMIYA
c4397318d3 Separate applehelp to sphinxcontrib package 2019-02-06 00:44:37 +09:00
Vincent Férotin
98fd02e262 doc: Enhance documentation about internalization of external extension. 2019-01-28 15:48:50 +01:00
Takeshi KOMIYA
2bd69350a7 Separate devhelp to sphinxcontrib package 2019-01-20 03:03:50 +09:00
Takeshi KOMIYA
6be9d2a08e Separate qthelp to sphinxcontrib package 2019-01-19 16:34:06 +09:00
Takeshi KOMIYA
20bf74c637 Separate jsmath to sphinxcontrib package 2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
6429c9e23c
Merge branch 'master' into refactor_singlehtml 2019-01-12 21:17:16 +09:00
Takeshi KOMIYA
8b6acc05c4
Merge pull request #5909 from tk0miya/refactor_epub2 
refactor: Convert Epub3Builder.validate_config_values() to a function
 2019-01-12 18:22:00 +09:00
Takeshi KOMIYA
354e765eef refactor: Convert Epub3Builder.validate_config_values() to a function 2019-01-12 18:05:28 +09:00
Takeshi KOMIYA
b08a7c4757 Move SingleFileHTMLBuilder to sphinx.builders.singlehtml package 2019-01-11 01:59:56 +09:00
Takeshi KOMIYA
e82f5ddb55 The arguments of Epub3Builder.build_navigation_doc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
b6c422ac86 The arguments of EpubBuilder.build_epub() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
64533e142c The arguments of EpubBuilder.build_toc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
d437f39bc4 The arguments of EpubBuilder.build_content() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
f000df8bfb The arguments of EpubBuilder.build_container() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
0f972e8bbf The arguments of EpubBuilder.build_mimetype() is deprecated 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
39c0380c4d refactor: deprecate some pycompat functions 2019-01-07 22:54:37 +09:00
Takeshi KOMIYA
353c3e9fd6
Merge pull request #5415 from tk0miya/5410_replace_open_file_by_open 
refactor: Repalce HTMLHelpBuilder.open_file() by standard open()
 2019-01-07 00:59:03 +09:00
Takeshi KOMIYA
56f4b27faa Deprecate LaTeXTranslator.generate_numfig_format() 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
45d04703fe latex: Move ExtBabel to sphinx.builders.latex.util package 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
3c7b4e77e0 refactor: Repalce HTMLHelpBuilder.open_file() by standard open() 2019-01-03 02:05:32 +09:00
jfbu
b62bf0e0fc Redo spelling fix lost in merge (contents moved to other file) 
modified:   doc/extdev/index.rst
 2018-12-28 16:03:26 +01:00
jfbu
32d57b8637 Merge branch '1.8' 
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
 2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
55a89196e4
Merge pull request #5678 from ArtFlag/docs/extension-tutorials 
Docs: Extension tutorial portal + helloworld example
 2018-12-23 22:55:24 +09:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
jfbu
f8389f5181 [DOC] Make link to list of deprecated APIs in CHANGES an internal link 2018-12-20 21:18:37 +01:00
Takeshi KOMIYA
6fe57436a8
Merge pull request #5839 from jdufresne/description 
Deprecate unused Exception attributes
 2018-12-20 10:15:06 +09:00
ArtFlag
870e2bbc1c move files to new directory 2018-12-19 17:35:17 +01:00
Takeshi KOMIYA
d0f5862597 Replace EnvironmentError and IOError by OSError 
Since python 3.3, EnvironmentError and IOError were merged into
OSError.
 2018-12-19 19:26:50 +09:00
Jon Dufresne
e9eaf41a58 Deprecate unused Exception attributes 
The attributes were used only for the string representation, but that is
also the default behavior of the Exception class. Observe:

>>> str(Exception('foo'))
'foo'
>>> print(Exception('foo'))
foo
 2018-12-18 18:32:16 -08:00
Takeshi KOMIYA
9574607578
Merge pull request #5827 from tk0miya/refactor_io3 
Refactor sphinx.io
 2018-12-18 23:28:50 +09:00