Commit Graph

274 Commits

Author SHA1 Message Date
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