2159 Commits

Author	SHA1	Message	Date
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
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
Takeshi KOMIYA	814abfd020	Fix #5018: wrong signature of env-merge-info and env-check-consistency	2018-05-28 21:38:16 +09:00
Jakob Lykke Andersen	6d52b63eee	C++, support for unions.	2018-05-26 20:03:25 +02:00
Jakob Lykke Andersen	f592483156	Add cpp:texpr role (style alternative to cpp:expr) ... Simplified version of sphinx-doc/sphinx#4836, thanks to mickk-on-cpp.	2018-05-26 17:25:41 +02:00
Takeshi KOMIYA	f3168d9894	Rename app.add_javascript() to add_js_file()	2018-05-24 23:59:49 +09:00
Takeshi KOMIYA	8fd34b88d3	add_javascript() allows keyword arguments as attributes for <script> tag	2018-05-24 23:59:49 +09:00
Takeshi KOMIYA	297ea8070f	Update docs	2018-05-24 23:55:12 +09:00
Takeshi KOMIYA	c8e38fbe3e	Refactor: Add DocumentTargetTransform to simplify LaTeX writer	2018-05-24 00:23:50 +09:00
Takeshi KOMIYA	489d86d470	Refactor: Add captioned_literal_block node to simplify LaTeX writer	2018-05-23 22:50:46 +09:00
Takeshi KOMIYA	e6c51bd535	refactor: Move math_reference node to sphinx.builders.latex.nodes ... The node is only used in latex builder. So this makes it builder- specific node.	2018-05-20 15:13:59 +09:00
Takeshi KOMIYA	5f31f9dbab	Enable eq role by default	2018-05-17 00:42:44 +09:00
Takeshi KOMIYA	a4c7be6fcd	Move MathDomain to sphinx.domains.math	2018-05-17 00:42:24 +09:00
Takeshi KOMIYA	e675ad2ec9	Enable math_block node rendering by default (without HTML builders)	2018-05-17 00:42:22 +09:00
Takeshi KOMIYA	4e04bff4f5	Enable math node rendering by default (without HTML builders) ... Nowadays, math elements (inline and block level equations) are integrated into reST spec by default. But, in Sphinx, they are not enabled by default. For this reason, users have to enable one of math extensions even if target builder supports math elements directly. This change starts to enable them by default. As a first step, this replaces math node and its structure by docutils based one.	2018-05-15 22:27:49 +09:00
Takeshi KOMIYA	71e5acc84a	doc: Fill N/A to deprecation list	2018-05-14 01:30:57 +09:00
Daniel M. Capella	d2b0098045	doc: Fix minor typo "like" -> "link"	2018-05-13 04:15:11 +00:00
Takeshi KOMIYA	5493bc1612	Merge branch 'master' into refactor_env2	2018-05-12 22:42:29 +09:00
Takeshi KOMIYA	0ed86d37a5	doc: viewcode	2018-05-12 11:35:54 +09:00
Takeshi KOMIYA	d6db20781a	Deprecate methods for pickling/unpickling on BuildEnvironment	2018-05-11 02:28:01 +09:00
Takeshi KOMIYA	fad03ea050	Rename viewcode_import to viewcode_follow_imported_members (refs: #4035)	2018-05-07 21:22:13 +09:00
Takeshi KOMIYA	f2af9ff97c	Merge branch 'master' into fix_4035_2	2018-05-06 23:27:51 +09:00
Takeshi KOMIYA	8c430197cc	Merge pull request #4934 from tk0miya/update_docs ... Update docs (refs: #4875)	2018-05-06 16:37:41 +09:00
Takeshi KOMIYA	8bc136a9cb	Use \sphinxcite instead of \cite	2018-05-03 20:58:30 +09:00
Takeshi KOMIYA	304c208d32	Add BibliographyTransform to restruct doctree for LaTeX	2018-05-03 20:54:42 +09:00
Takeshi KOMIYA	5a90e0bc85	Update docs (refs: #4875)	2018-05-03 17:40:32 +09:00