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
11,018 Commits 2 Branches 219 Tags
60b160431a4083a58a4d09051d5fba2275e2b712
Commit Graph

2083 Commits

Author SHA1 Message Date
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
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
Takeshi KOMIYA
1ebf6d4983 Merge pull request #5111 from stephenfin/tox-fixes 
Run everything but unit tests under Python 3
 2018-06-26 00:59:36 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02:00
Stephen Finucane
2a4827af4f make: Default to Python 3 
As with the tox change, it makes sense to test things against Python 3
by default now, seeing as that will be the only version supported in
Sphinx 2.0.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-21 15:11:35 +01:00
Martin Larralde
a68298b7d8 Update napoleon docs with features from #4613 2018-06-21 14:10:52 +02:00
Takeshi KOMIYA
f14d60dcd2 Merge pull request #5096 from tk0miya/update_docs 
doc: update URL of PDF and EPUB
 2018-06-21 01:29:42 +09: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
Stephen Finucane
0b81af6a2e doc: Rework "extensions" documents 
This is mostly spacing and other "niceness" fixes.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:26:59 +01:00
Stephen Finucane
b595c4a45b doc: Add "builders" to usage guide 
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:26:59 +01:00
Stephen Finucane
7e27e09493 doc: Rework "builders" document 
There are a number of cleanup items.

- Some paragraphs are reworded or clarified
- Semantic markup is added where possible
- Everything is wrapped to ~80 characters

A number of TODOs are inserted. These will be resolved separately.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-06-20 09:26:59 +01:00
Takeshi KOMIYA
fd8e0be57a Merge branch '1.7' 2018-06-19 23:39:23 +09:00
Takeshi KOMIYA
1dffeba0bc Merge pull request #5102 from tk0miya/update_docs3 
doc: Use badge to show latest release
 2018-06-19 23:35:42 +09:00
Takeshi KOMIYA
b84240d871 Merge pull request #5108 from tk0miya/alabaster-0.711 
Alabaster 0.711
 2018-06-19 23:35:17 +09:00
Jakob Lykke Andersen
cff1146775 Customizable Python interpreter in doc/Makefile 
Fix after previous stray edit.
 2018-06-17 09:57:52 +02:00
Takeshi KOMIYA
0e8fb2dd25 doc: update download URL for PDF and EPUB 2018-06-17 16:55:18 +09:00
Takeshi KOMIYA
248869e2db doc: Use badge to show latest release 2018-06-17 16:45:58 +09:00
shimizukawa
1b36b3fef7 make.bat must follow #4097. 2018-06-17 15:24:23 +09:00
Takayuki SHIMIZUKAWA
0f1eb957af Merge pull request #5083 from dombre/master 
Fixed internationalization quick guide
 2018-06-17 15:20:05 +09:00
Takeshi KOMIYA
af1502c32e Merge pull request #5084 from tk0miya/3784_mathjax_integrity 
Close #3784: mathjax: Add :confval:`mathjax_options`
 2018-06-17 00:33:58 +09:00
Takeshi KOMIYA
71c0eb6b1a Merge branch '1.7' 2018-06-16 18:23:36 +09:00
Takeshi KOMIYA
0016bccb67 Merge pull request #5087 from jflory7/fix/google-style-guide 
Update Google style guide link (previous link deprecated)
 2018-06-15 22:46:11 +09:00
Roy Wellington Ⅳ
503eb7f2fd Fix minor typo of "them" 2018-06-13 23:13:23 +02:00
Roy Wellington Ⅳ
d66e663f28 Fix minor typo of "them" 2018-06-13 11:25:21 -07:00
Justin W. Flory
61ef928310 Update Google style guide link (previous link deprecated) 2018-06-13 12:12:49 -05:00
Takeshi KOMIYA
34126021d9 Close #3784: mathjax: Add :confval:mathjax_options 2018-06-13 23:24:21 +09:00
dombre
5df7228cde Update intl.rst 
Fixes #5081
 2018-06-13 15:32:41 +02:00
Drew Risinger
fb5a4cbcc0 Autodoc.rst typo: ommit->omit 
Fix typo in docs/ext/autodoc.rst. Changed "ommit"->"omit"
 2018-06-12 23:54:35 -04: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
40ee7cd0c4 Merge pull request #5029 from kmaehashi/autosummary-inherited-docs 
autosummary: expose inherited_members to template
 2018-06-09 22:11:03 +09:00
Jakob Lykke Andersen
cc026946f7 C++, add support for anon entities. 
Anonymous entities are specified with names starting with "@",
but are rendered as "[anonymous]".

Fixes sphinx-doc/sphinx#3593 and sphinx-doc/sphinx#2683.
 2018-06-09 12:24:34 +02: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
Takeshi KOMIYA
9617b138c7 Merge pull request #5049 from tk0miya/4193_canonical_url 
html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set
 2018-06-09 02:35:56 +09:00
Jonathan Demaeyer
7ed05e1d69 Link to cdnjs was incorrect 2018-06-08 13:56:45 +02:00
jfbu
359854fa78 Postpone to 3.0 removal of ExtBabel.get_shorthandoff() 2018-06-07 18:29:24 +02:00
Takeshi KOMIYA
b914327317 Reorder deprecated APIs (app) 2018-06-08 00:51:00 +09:00
Takeshi KOMIYA
e081b1f154 Reorder deprecated APIs (env) 2018-06-08 00:51:00 +09:00
Takeshi KOMIYA
a2c4ed6614 Fix wrong module name in CHANGES 2018-06-08 00:51:00 +09: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
Takeshi KOMIYA
158d7d2fd3 docs: Fix location of attributes 2018-06-05 22:57:04 +09:00
Kenichi Maehashi
270c1883e8 expose inherited_members to autosummary template 2018-06-01 13:29:00 +09:00
Takeshi KOMIYA
72011465ad Merge pull request #5020 from tk0miya/5018_update_docs 
Fix #5018: wrong signature of env-merge-info and env-check-consistency
 2018-05-29 01:25:46 +09:00
Takeshi KOMIYA
1deceda6da Merge branch 'master' into 3606_load_mathjax_async 2018-05-28 23:04:13 +09:00
Takeshi KOMIYA
3c6be1b5b3 Merge pull request #5008 from tk0miya/refactor_latex2 
Refactor latex writer
 2018-05-28 22:59:40 +09:00
Takeshi KOMIYA
7c1613be18 Merge pull request #5013 from tk0miya/fix_doc 
Update docs (T/O)
 2018-05-28 22:57:33 +09:00