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
12,544 Commits 2 Branches 219 Tags 163 MiB
9ac06520b9
Commit Graph

138 Commits

Author SHA1 Message Date
Takeshi KOMIYA
76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -08:00
Takeshi KOMIYA
4761e70c37 Merge branch '1.8' 2018-11-22 22:14:32 +09: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
Dmitry Shachnev
2a9cad7b2e Move language-specific data into a new JS file, language_data.js 
This file is included in script_files, so it will be present even for
projects using custom templates.

Fixes #5460.
 2018-11-04 12:13:07 +03:00
Takeshi KOMIYA
a912d90440 doc: app.info() should allow keyword argument 2018-09-20 20:32:41 +09:00
Takeshi KOMIYA
48d4a52276 doc: Update workaround for RTD 2018-09-20 20:29:56 +09:00
Takeshi KOMIYA
a4843cab2c Fix typo 2018-09-20 20:27:25 +09:00
Takeshi KOMIYA
134bcde40b Add workaround for RTD (refs: #5461) 2018-09-20 20:17:21 +09: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
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
7b44adb048 Use xindy for Sphinx's own PDF documentation 
Makeindex gathered under heading "Symbols" all command line options,
this seems less satisfactory than index produced by xindy.
 2018-07-14 19:15:33 +02:00
Jon Dufresne
2f17a0e8c8 Update Python 2 doc links to Python 3 
Python 3 docs are more actively maintained and are the future.
 2018-06-09 20:59:43 -07:00
Takeshi KOMIYA
69624bffa7 doc: Fix filename 2018-04-12 00:49:31 +09:00
jfbu
bfdf0d1e83 Merge branch '1.7' 2018-03-30 22:50:55 +02:00
jfbu
d8b9baf1cb Better font config for Sphinx own PDF docs 2018-03-30 10:32:08 +02:00
jfbu
39ce9d9ab9 Fix Unicode Character U+229E (SQUARED PLUS) breaks Sphinx docs in LaTeX 
refs: PR #4794
 2018-03-30 00:11:17 +02:00
Takeshi KOMIYA
9f5c676322 Use flake8-import-order 2018-01-28 01:52:16 +09:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page 
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:40 +01:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +09:00
jfbu
b18a3f82b4 Fix flake8 2017-05-20 10:16:24 +02:00
jfbu
6422f7b8c9 Fix #3742: missing `Index` bookmark and TOC entry in PDF builds at RTD 
The trick is to create an Index TOC/bookmarks entry in anticipation of
makeindex execution, as RTD (currently) does only one pdflatex run after
makeindex.

    https://github.com/rtfd/readthedocs.org/issues/2857

The workaround works for Sphinx own docs, which uses ``'manual'``
docclass and puts the general index at very end of document.
 2017-05-20 09:54:09 +02:00
Takeshi KOMIYA
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
jfbu
89431bf833 Fix accidental use of `language='ja'` in docs (at 41bb388) 2017-03-23 11:03:38 +01:00
jfbu
41bb38877f Update docs (domains.rst) 2017-03-21 08:24:35 +01:00
jfbu
c240a90f18 improve the index appearance in Sphinx's own PDF documentation 2017-02-05 23:20:30 +01:00
jfbu
a48a9c883a style the latex chapter in the docs (for pdf output) 2016-10-29 16:30:33 +02:00
Takeshi KOMIYA
ec934d476a Fix #2983: Rename `epub3_description and epub3_contributor to epub_description and epub_contributor`. 2016-10-01 00:17:19 +09:00
Yoshiki Shibukawa
8f162a132e fix epub warning in Sphinx's document 2016-08-09 16:58:56 +09:00
Yoshiki Shibukawa
06a861703d Reduce epub checker warnings/errors for epub3 builder. 
Fix DOCTYPE to html5 and change extension from .html to .xhtml.

Sphinx's documents result:

  before: 95 warnings& 1238 errors
  after: 623 errors
 2016-07-17 09:53:04 +09:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Georg Brandl
548a6dc22e final pep8 fixes; reactivate most warnings in flake8 2015-03-08 17:15:54 +01:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Takayuki Shimizukawa
5bd2143fd0 enable sphinx.ext.viewcode for sphinx doc itself 2014-10-28 13:45:27 +09:00
Georg Brandl
a973daea41 make :any: role work with intersphinx! 2014-09-19 13:31:55 +02:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Roland Meister
73a1420cc6 Add epub_guide entry to doc/conf.py 
The toc for the spinx documentation actually is in contents.rst.
 2013-06-19 21:02:27 +02:00
Takayuki Shimizukawa
649a75c427 add 'locale_dirs' and 'gettext_compact' to conf.py for translation setup easier 2013-03-31 12:22:08 +09:00
Roland Meister
a567d77e51 epub_use_index instead of html_use_index for epub builder (Issue #1106) 
The change adds the method get_builder_config.
This allows use of the option epub_use_index instead
of html_use_index for epub output.
 2013-03-06 18:43:21 +01:00