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,333 Commits 2 Branches 219 Tags 163 MiB
53c1dff91c
Commit Graph

99 Commits

Author SHA1 Message Date
Takeshi KOMIYA
e527be396a
Merge pull request #5607 from tk0miya/smart_texinfo_conf_py 
quickstart: Simplify generated conf.py (for texinfo)
 2018-12-02 01:30:51 +09:00
Jean-François B
8412bdf9d6
Merge pull request #5645 from jfbu/latex_greek_cyrillic_letters 
LaTeX: support for Greek and Cyrillic
 2018-11-21 23:11:15 +01:00
jfbu
1edf2a45b9 LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeX 2018-11-21 22:21:02 +01:00
jfbu
2825e338c2 LaTeX: support for Greek and Cyrillic 
0. do not escape Unicode Greek letters via LaTeX math mark-up: pass them
   through un-modified to LaTeX document,

1. if "fontenc" receives extra option LGR, then pdflatex will support
   Unicode Greek letters (not in math), and with extra option T2A it
   will support (most) Unicode Cyrillic letters.

2. for pdflatex with LGR, this will use "textalpha" LaTeX package and
   "substitutefont" package to set up some automatic font substitution
   to work around the unavailability of Greek with "times"
   package (which is default font package chosen by Sphinx for
   pdflatex), same with T2A and "substitutefont" for Cyrillic.

3. for xelatex/lualatex, set up Computer Modern Unicode as default font,
   as it supports Cyrillic and Greek scripts,

4. for platex, don't do anything special as the engine already has
   its default font supporting Cyrillic and Greek (even in math mode!)

Closes: #5251
Fixes:  #5248
Fixes:  #5247
 2018-11-16 21:14:51 +01: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
Takeshi KOMIYA
aeadcdd0b6 doc: Reorder section 2018-11-11 21:57:14 +09:00
Takeshi KOMIYA
83c50837c1
Merge pull request #5564 from nomis/rst-typo 
doc: Fix typo of "restructuredtext"
 2018-10-25 22:07:00 +09:00
Simon Arlott
7aa750a637
doc: Fix typo of "restructuredtext" 2018-10-24 19:52:42 +01:00
Simon Arlott
f5d4e4207d
doc: Fix typo of "default" 2018-10-24 19:52:24 +01:00
Takeshi KOMIYA
973c3ffa25
Merge branch 'master' into change_master_doc_to_index 2018-09-29 21:12:40 +09:00
Takeshi KOMIYA
07fd1c0680 Fix #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix 2018-09-08 23:11:14 +09:00
Takeshi KOMIYA
abcb5bd5ec The default setting for master_doc is changed to 'index' 2018-09-04 01:14:16 +09:00
TAKEDA-Takashi
683cccac4d docs: Fix wrong name of MecabSplitter 2018-09-03 16:18:24 +09:00
Timotheus Kampik
26bd565dee Merge branch 'master' into 1618-make-search-results-reader-friendly 2018-08-27 21:34:43 +02:00
Takeshi KOMIYA
f670a33f5b Fix #5246: Add :confval:singlehtml_sidebars to configure sidebars for singlehtml 2018-08-13 11:04:45 +09:00
Takeshi KOMIYA
68630e68b9 Merge branch '1.7' 2018-08-04 20:34:42 +09:00
Jean-François B
5edcb2850c
Merge pull request #5239 from jfbu/latex_revert_5181_RTDbug_workaround 
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
 2018-07-31 19:04:21 +02:00
jfbu
d07103fde2 Fix typo in updated docs 2018-07-31 17:11:59 +02:00
jfbu
b8f43e56ae Update latex docs 2018-07-31 16:54:25 +02:00
jfbu
f0067f4a04 Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD" 
This reverts commit 9b2aac68ea.
 2018-07-31 10:46:48 +02:00
jfbu
9a0097bef2 Update LaTeX xindy docs 2018-07-30 19:52:12 +02:00
Takeshi KOMIYA
e045dacc84 doc: Move description for math confval, directives and roles to usage 2018-07-28 18:43:02 +09:00
Takeshi KOMIYA
a3189b460c
Merge pull request #5136 from TimKam/4255-clarify-startdocname-config-param 
#4255 clarify documentation of ``startdocname`` parameters.
 2018-07-21 16:31:48 +09:00
Timotheus Kampik
395d60d49e #4255 improve conciseness 2018-07-19 21:10:16 +02:00
Takeshi KOMIYA
a7ea9d7c5b
Merge pull request #5185 from TimKam/4886-linkcheck-ignore-doc 
4886 correct link check ignore doc
 2018-07-19 23:52:29 +09:00
Timotheus Kampik
8066d36e3c #4886 clarify example/note 2018-07-18 19:40:22 +02:00
Timotheus Kampik
f605012617 #4886 remove obsolete * 2018-07-17 20:40:49 +02:00
Timotheus Kampik
6bbfc3bba9 #1618 remove obsolete warning from doc 
Setting `html_copy_source` no longer affects search results
 2018-07-17 19:59:29 +02:00
Timotheus Kampik
537a69e518 #4886 adjust documentation to match actual link check behavior 2018-07-16 23:22:26 +02:00
Jean-François B
54456ba455
Merge branch 'master' into 3742_index_in_PDF_bookmark_at_RTD 2018-07-16 17:15:45 +02:00
jfbu
9b2aac68ea LaTeX: extend to all projects the #3742 fix for PDF builds at RTD 
Refs: https://github.com/rtfd/readthedocs.org/issues/2857
 2018-07-15 15:24:25 +02:00
jfbu
60b160431a LaTeX: add hyperref support to general index as handled by xindy 
- achieve hyperlinked page numbers in general index, despite xindy's
  incompatibility with hyperref,

- obtain compatibility of pdflatex with xindy for documents with
  Cyrillic scripts,

- use xindy by default with xelatex/lualatex because any non-ascii
  character as first letter of an indexed term breaks PDF build if using
  makeindex with lualatex, and produces incoherent index with xelatex.

This commit also switches off xindy logs (which were activated in parent
commits) as they are voluminous and not of immediate use to Sphinx user.
 2018-07-14 19:13:59 +02:00
Timotheus Kampik
94b467dbc8 #4255 clarify documentation of `startdocname` parameters. 
* Relative path from source directory

* Similar to ``master_doc`` in functionality
 2018-07-01 16:10:51 +02:00
jfbu
90c2b528b1 Update docs and CHANGES for `latex_use_xindy` config variable 2018-06-30 23:37:26 +02:00
Takeshi KOMIYA
1140e81df7 Merge remote-tracking branch 'stephenfin/doc-rework' 2018-06-26 01:05:19 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02:00
Stephen Finucane
d9ccc95717 doc: Add "extensions" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:30:47 +01:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files 
Add :confval:`html_js_files`
 2018-06-09 11:51:11 +09:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable 2018-06-08 19:53:46 +02:00
Takeshi KOMIYA
9fc2657d7e Add :confval:html_js_files 2018-06-09 02:38:36 +09:00
jfbu
359854fa78 Postpone to 3.0 removal of ExtBabel.get_shorthandoff() 2018-06-07 18:29:24 +02:00
jfbu
b41b1dac5c Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff() 
This partially reverts d17f3955a5
 2018-06-06 19:16:14 +02:00
Takeshi KOMIYA
e30b10a57d html: Output `canonical_url metadata if :confval:html_baseurl` set 2018-06-06 21:18:17 +09:00
jfbu
a32c358342 Remove usage of internal shorthandoff variable from LaTeX writer 2018-06-05 18:38:59 +02:00
Daniel M. Capella
d2b0098045
doc: Fix minor typo "like" -> "link" 2018-05-13 04:15:11 +00:00
Takeshi KOMIYA
5a90e0bc85 Update docs (refs: #4875) 2018-05-03 17:40:32 +09:00
Takeshi KOMIYA
cbf4ee24f9 Fix #4811: The files under html_static_path are excluded from source 2018-05-03 11:07:14 +09:00
Stephen Finucane
0bf8886fc4 doc: Address review comments 
These came up in the review for pull request #4799.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:41:12 +01:00
Stephen Finucane
16e76faba3 doc: Add "config" to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-04-30 21:36:45 +01:00