Commit Graph

2117 Commits

Author SHA1 Message Date
Takeshi KOMIYA
609ec5ef33 Merge branch 'master' into 4614_keep_going 2018-07-31 01:11:08 +09:00
Takeshi KOMIYA
5fd62810b9 Merge pull request #5229 from tk0miya/refactor_latex2
Check latex_elements at config-inited event
2018-07-30 23:16:02 +09:00
Takeshi KOMIYA
5520969b39 Merge pull request #5228 from tk0miya/move_make_mode_to_sphinx.cmd
Move make mode to sphinx.cmd
2018-07-30 23:11:26 +09:00
Takeshi KOMIYA
90246b82b5 Check latex_elements at config-inited event 2018-07-29 22:43:13 +09:00
Takeshi KOMIYA
c8a66b73cf Update CHANGES 2018-07-29 22:24:56 +09:00
Takeshi KOMIYA
7218fe9dca Deprecate whole of sphinx.ext.mathbase 2018-07-29 12:32:46 +09:00
Takeshi KOMIYA
104bd42f51 Merge branch 'master' into refactor_highlighter 2018-07-29 11:21:36 +09: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
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
9bb1e83668 Merge branch 'master' into refactor_highlighter 2018-07-24 01:11:57 +09:00
Takeshi KOMIYA
e3483e9b04 Closes #4614: sphinx-build: Add :option:--keep-going option to show all warnings 2018-07-23 00:38:47 +09:00
Takeshi KOMIYA
ec8e06bad7 Merge pull request #5202 from tk0miya/4500_collapsiblesidebar_works_with_stickysidebar
doc: collapsiblesidebar works well with stickysidebar
2018-07-22 21:12:58 +09:00
Takeshi KOMIYA
d0900001af doc: collapsiblesidebar works well with stickysidebar 2018-07-22 00:09:11 +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
Takeshi KOMIYA
f3019ee197 Apply :confval:trim_doctest_flags to all builders (cf. text, manpages) 2018-07-21 13:54:51 +09:00
Takeshi KOMIYA
4f296c5e67 Refactor: Run highlightlang on resolving phase 2018-07-21 13:54:09 +09:00
Takeshi KOMIYA
0c277f3ff0 `sphinx.highlighting.PygmentsBridge.unhighlight()` is deprecated 2018-07-21 01:50:23 +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
Takeshi KOMIYA
f72a53f5bd Update docs for #5122 (nitpicky option) 2018-07-19 01:22:20 +09:00
Timotheus Kampik
f605012617 #4886 remove obsolete * 2018-07-17 20:40:49 +02:00
Takeshi KOMIYA
d96574d72d Merge pull request #5188 from mgeier/patch-1
DOC: Fix typo: add_source_parsers() -> add_source_parser()
2018-07-17 23:23:44 +09:00
jfbu
e584b8e1db Update LaTeX docs 2018-07-17 15:45:30 +02:00
Matthias Geier
e1772bafda DOC: Fix typo: add_source_parsers() -> add_source_parser() 2018-07-17 10:00:05 +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
Takeshi KOMIYA
d3cc565749 Merge branch 'master' into 4976_location_for_logger.info 2018-07-16 17:18:24 +09:00
Jean-François B
6c12dba968 Merge pull request #5134 from jfbu/latex_xindy
Add new config value ``latex_use_xindy``
2018-07-16 10:17:06 +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
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
Dan Abdinoor
83c9380299 Fix links to sphinx-build man page
Swap``program`` for ``doc`` links to sphinx-build man page.
2018-07-10 12:14:45 -04: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
Takeshi KOMIYA
910be1e2a2 Close #4976: `SphinxLoggerAdapter.info() now supports location` parameter 2018-06-26 01:02:37 +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