2281 Commits

Author	SHA1	Message	Date
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
Takeshi KOMIYA	8febb09373	Merge branch 'master' into refactor_latex_footnotes	2018-05-03 11:40:44 +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
Takeshi KOMIYA	0ea06e40ca	Merge branch 'master' into 789_escape_braces_on_samp_role	2018-05-03 01:32:35 +09:00
Takeshi KOMIYA	b90c2576d6	Merge pull request #4880 from tk0miya/refactor_env2 ... Refactor BuildEnvironment: Move read_doc() method to Builder class	2018-05-01 23:45:21 +09:00
Takeshi KOMIYA	39fe7ee293	refactor: Move env.write_doctree() to Builder._write_doctree()	2018-05-01 23:06:05 +09:00
Takeshi KOMIYA	90949a3b4f	refactor: Move env.read_doc() to Builder._read_doc()	2018-05-01 23:06:05 +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
Stephen Finucane	ac19be3585	doc: Rework "config" document ... Wrap some lines and format some definition lists as such. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-04-30 21:36:44 +01:00
Stephen Finucane	d1972ac5b5	doc: Add "markdown" section to usage guide ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-04-30 21:36:44 +01:00
Stephen Finucane	dcf07f8005	doc: Rework "markdown" 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 Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-04-30 21:36:44 +01:00
Stephen Finucane	7a8d1dc08c	doc: Fix line length ... Keep things in the fixed docs under 80 characters. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-04-30 21:36:44 +01:00
Takeshi KOMIYA	8e6c04c630	Merge branch 'master' into deprecate_highlightlang_directive	2018-04-29 21:13:13 +09:00
Takeshi KOMIYA	a31e7beee7	Merge branch 'master' into refactor_latex_footnotes	2018-04-29 21:09:46 +09:00
Takeshi KOMIYA	4118e8b35b	Merge branch 'master' into refactor_config	2018-04-29 19:00:04 +09:00
Takeshi KOMIYA	6b397d1fb1	Show warnings for deprecated html_search_options	2018-04-28 14:34:49 +09:00
Takeshi KOMIYA	a68f772d7a	Merge branch 'master' into refactor_config	2018-04-28 13:05:47 +09:00
Takeshi KOMIYA	b165ade6b0	Rename Config.read_from_py() to Config.read()	2018-04-28 13:05:28 +09:00
Takeshi KOMIYA	622119a9d4	Fix #789: `:samp:` role supports to escape curly braces with backslash	2018-04-28 12:56:01 +09:00
Ashley Whetter	44da51a564	Plugins can find source code for viewcode ... Fixes #4035	2018-04-24 14:45:16 -07:00
Sumana Harihareswara	3b36ac8f53	Fix PyPI link in theming docs	2018-04-23 09:27:17 -04:00
Takeshi KOMIYA	d505d232de	Merge pull request #4884 from tk0miya/4873_adjust_word-break ... Fix #4873: Adjust word-break of deprecated-APIs table	2018-04-22 21:31:56 +09:00
Takeshi KOMIYA	d97dc05b37	Fix #4873: Adjust word-break of deprecated-APIs table	2018-04-22 20:00:46 +09:00
Takeshi KOMIYA	5897d45cc6	Merge branch 'master' into refactor_config	2018-04-22 18:56:04 +09:00
Takeshi KOMIYA	bed764316f	Merge pull request #4875 from tk0miya/4859_update_docs ... doc: Add a note for dotfiles on html_static_path (refs: #4859)	2018-04-22 18:33:39 +09:00
Takeshi KOMIYA	1542622cf7	Merge pull request #4853 from tk0miya/4810_order_of_transforms ... Change processing order of reading a document	2018-04-21 19:17:27 +09:00
Takeshi KOMIYA	ed3bc1a87e	Merge pull request #4833 from tk0miya/add_docs_for_ImageConverter ... doc: Add ImageConverter to utils	2018-04-21 14:44:02 +09:00
Takeshi KOMIYA	6b14cd3bd6	Change priority of versioning doctrees	2018-04-21 11:28:23 +09:00
Takeshi KOMIYA	fdb96bb948	doc: Update about sphinx.ext.imgconverter	2018-04-21 11:21:27 +09:00
Takeshi KOMIYA	ea7d30a190	doc: Add ImageConverter to utils	2018-04-21 11:21:27 +09:00
Takeshi KOMIYA	5a63c2970f	doc: Add a note for dotfiles on html_static_path (refs: #4859)	2018-04-21 11:02:46 +09:00
Takeshi KOMIYA	abf8999ce7	Deprecate footnotes helpers	2018-04-20 22:14:49 +09:00
Jon Dufresne	365c93f227	Update all pypi.python.org URLs to pypi.org ... For details on the new PyPI, see the blog post: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html	2018-04-18 19:51:48 -07:00
Takeshi KOMIYA	b35198d847	Deprecate highlightlang directive ... highlightlang directive is not documented, and marked as old in v0.2.	2018-04-15 00:33:02 +09:00
Gussie Carther	390ea6d35a	Fix #4420: Docs conflict on use of rst_prolog and rst_epilog	2018-04-14 17:51:06 +09:00
Takeshi KOMIYA	c35eb6fade	Merge pull request #4815 from tk0miya/refine_add_css_file ... Refine adding CSS files	2018-04-13 00:21:33 +09:00
Takeshi KOMIYA	c12d616be9	Merge pull request #4819 from TimKam/1428-web-support-wrong-static-param-doc ... #1428 update websupport API doc	2018-04-12 23:43:31 +09:00
Takeshi KOMIYA	35e4bd498f	Merge pull request #4831 from tk0miya/fix_docs ... Fix docs	2018-04-12 23:42:35 +09:00
Nicholas Devenish	5685512e6a	Add missing literalinclude options documentation ... The start-at and end-at options, added in 560b572 for v1.5a1, #625 weren't previously documented. This fixes that.	2018-04-11 18:10:37 +01:00
Takeshi KOMIYA	69624bffa7	doc: Fix filename	2018-04-12 00:49:31 +09:00
Takeshi KOMIYA	5fd7bd7a12	doc: Fix broken link	2018-04-12 00:49:27 +09:00
Takeshi KOMIYA	b2bd9f75a6	Merge branch '1.7'	2018-04-09 01:46:00 +09:00
Takeshi KOMIYA	1dd605971c	Merge pull request #4804 from tk0miya/add_SphinxDirective ... Add SphinxDirective class	2018-04-08 23:30:19 +09:00
Timotheus Kampik	aa5a7e5916	#1428 further indent note	2018-04-08 13:40:23 +02:00
Timotheus Kampik	841a123c39	#1428 move/indent note	2018-04-08 13:38:53 +02:00
Timotheus Kampik	39678b7a61	#1428 update websupport API doc ... * ``staticdir`` was not correctly documented * ```staticroot`` was not correctly documented at all	2018-04-07 17:24:50 +02:00
Takeshi KOMIYA	bd2967f1d2	Add :confval:epub_css_files	2018-04-06 13:11:24 +09:00
Takeshi KOMIYA	5efecd2150	Add :confval:html_css_files	2018-04-06 13:11:24 +09:00
Takeshi KOMIYA	3afc72fba4	Rename add_stylesheet() to add_css_file()	2018-04-06 13:11:24 +09:00
jfbu	e81f80880a	Slight rework of latex doc	2018-04-02 19:47:57 +02:00
jfbu	5473851e8c	Improve formatting of docs about LaTeX builder	2018-04-02 19:23:13 +02:00
Takeshi KOMIYA	6030e7390d	Merge pull request #4800 from tk0miya/drop_document.settings.gettext_compact ... Drop `document.settings.gettext_compact`	2018-04-02 22:58:05 +09:00
Takeshi KOMIYA	47918f365e	Merge branch 'master' into refactor_config	2018-04-02 10:47:47 +09:00
shimizukawa	eb1e8f937c	So far, the Sphinx-doc project name on the transifex service included the latest major version number. For example "sphinx-doc-1_8". For this reason, we released a major version, we had to create a new project with transifex and took time to switch the data to be translated. This was to keep the translated text of the past version on transifex. ... From now on, transifex project name does not include version number like "sphinx-doc". Project data always handles the contents of Sphinx's master branch. Translation of the major version of the past is held at https://travis-ci.org/sphinx-doc/sphinx-doc-translations.	2018-04-01 21:50:13 +09:00
Takeshi KOMIYA	bc63dc8450	Rename Config.read() to Config.from_conf_py()	2018-04-01 20:07:45 +09:00
jfbu	525f3bd104	Typo from #4801	2018-04-01 11:39:58 +02:00
jfbu	a831d6da53	Docs of fonts for LaTeX builds	2018-03-30 23:05:42 +02:00
jfbu	bfdf0d1e83	Merge branch '1.7'	2018-03-30 22:50:55 +02:00
Takeshi KOMIYA	c5e811459e	Merge pull request #4801 from timgraham/add-links ... Add section labels for intersphinx	2018-03-31 00:10:03 +09:00
Takeshi KOMIYA	ab04a55dbf	Add document for utility classes	2018-03-31 00:05:03 +09:00
jfbu	d8b9baf1cb	Better font config for Sphinx own PDF docs	2018-03-30 10:32:08 +02:00
jfbu	98e73ecf77	Improve latex docs about fonts	2018-03-30 10:30:05 +02:00
jfbu	9a20927593	Improve choice of lexers for highlighting in Installing Sphinx (docs) ... cf http://pygments.org/docs/lexers/#lexers-for-various-shells The difference with prior situation shows more in PDF output (but for Windows example visible already in html) than in HTML with used theme. I am not sure why ``select`` is highlighted but not ``sudo`` but this was case already before.	2018-03-30 09:13:50 +02:00
Takeshi KOMIYA	962b6d459e	Drop document.settings.gettext_compact	2018-03-30 13:06:11 +09: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
Jean-François B	034e69fe73	Merge pull request #4793 from jfbu/larger_typeface_in_xetex_code_blocks ... Let LaTeX with XeTeX/LuaTeX use normal sized typeface in code-blocks	2018-03-29 23:43:25 +02:00
Tim Graham	725d20b0f9	Add section labels for intersphinx	2018-03-29 13:23:39 -04:00
Takeshi KOMIYA	448db58d88	Merge pull request #4760 from tk0miya/add_override_option ... Add a new keyword argument ``override`` to Application APIs	2018-03-29 23:26:08 +09:00
jfbu	3839d74aa8	Typo (Sphinx version number wrong in documentation of `'fvset'` key)	2018-03-29 15:22:34 +02:00
Takeshi KOMIYA	90c55f387a	Merge pull request #4794 from kenyon/patch-1 ... installation.rst: correct Windows Run keyboard shortcut	2018-03-29 22:19:20 +09:00
Takeshi KOMIYA	72a0896bd0	Merge branch 'master' into add_override_option	2018-03-29 22:03:05 +09:00
Takeshi KOMIYA	c644ad7cae	Merge pull request #4700 from stephenfin/doc-rework ... Doc rework (user guide, part 3)	2018-03-29 22:00:09 +09:00
Takeshi KOMIYA	61828786a6	Deprecate app.override_domain()	2018-03-29 21:59:29 +09:00
Takeshi KOMIYA	a24601aa24	Deprecate Config.check_unicode()	2018-03-29 10:32:49 +09:00
Kenyon Ralph	7581e90dce	installation.rst: correct Windows Run keyboard shortcut ... You type Windows-R to get the Run dialog, not Control-R.	2018-03-28 18:04:05 -07:00
jfbu	8c55793902	Let LaTeX with XeTeX/LuaTeX not use small typeface in code-blocks ... closes: #4791	2018-03-28 23:17:34 +02:00
Takeshi KOMIYA	febca7cf26	Merge branch 'master' into refactor_config	2018-03-28 01:01:03 +09:00
Stephen Finucane	2565195a44	doc: Add "domains" doc to usage guide ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	893a7ac1f2	doc: Rework "showing code" section ... This makes the section more consistent with the rest of the document. This adds a new section to the basics guide for doctest blocks, which are a docutils thing. It also update the default highlight language, which is now 'default'. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	ecd193cde8	doc: Extend "directives" doc, part 3 ... Finish building up this combined doc by adding the contents of the former 'misc' document. There are no changes to the content. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	e01e9e34bb	doc: Extend "directives" doc, part 2 ... Continue building up this combined doc by adding the contents of the former 'code' document. There are no changes to the content. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	0641209da9	doc: Extend "directives" doc, part 1 ... Continue building up this combined doc by adding the contents of the former 'para' document. There are no changes to the content. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	fdf91e502c	doc: Add "directives" doc to restructuredtext section ... There's simply no need to artificially divide up the documentation on directives into multiple, hard-to-navigate documents. Gather all documentation for directives into one easy-to-reference guide, starting with the former 'toctree' document. There are no changes to the content. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	0167c009c2	doc: Rework "markup" documents ... These are going to form the basis of a future 'directive' document, so we do some cleanup before this happens. 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 Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:28 +01:00
Stephen Finucane	08ff8160b8	doc: Add "field-lists" doc to restructuredtext section ... These are very poorly documented at present, especially given their power and use in basically all non-Napoleon based Python documentation. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:37:25 +01:00
Stephen Finucane	3fcb1bd2dd	doc: Add "roles" doc to restructuredtext section ... This is essentially the 'markup/inline' with a few small fixes. There are also some modifications to the basic rST guide to highlight what a role is; we were doing this for directives but not roles. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:34:36 +01:00
Stephen Finucane	9c2ab8c3bb	doc: Add "restructuredtext" section to usage guide ... This is taken from the existing 'rest' documents. Little to no modifications are necessary, thankfully. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-03-27 15:34:26 +01:00
Takeshi KOMIYA	0f3fa689a4	Deprecate env._nitpick_ignore	2018-03-26 02:05:58 +09:00
Takeshi KOMIYA	78cbf96158	Deprecate Config.check_types()	2018-03-24 00:29:11 +09:00
Takeshi KOMIYA	ba83214386	Refactor: Add Config.read() as a constructor ... To simplify Config.__init__() method, this separates conf.py parsing feature to Config.read() method. This allows to instantiate config object simply.	2018-03-23 23:40:28 +09:00
cocoatomo	c0ec1ab23e	Minor typo	2018-03-22 23:20:02 +09:00
Takeshi KOMIYA	f9753e30de	Merge branch '1.7'	2018-03-21 20:55:30 +09:00
Takeshi KOMIYA	451168d292	Merge pull request #4764 from tk0miya/4744_add_canonical_url ... Fix #4744: Add canonical URL to docs	2018-03-21 14:45:15 +09:00
Takeshi KOMIYA	d8c107a61b	Fix #4744: Add canonical URL to docs	2018-03-21 00:01:44 +09:00
Takeshi KOMIYA	0a8e3f5087	Fix #4724: doc: an example of autogen is incorrect	2018-03-20 22:58:21 +09:00
Takeshi KOMIYA	2c7d08ee47	Merge branch '1.7'	2018-03-19 23:46:15 +09:00
Takeshi KOMIYA	0ad232696a	Update docs (refs: #2307)	2018-03-19 00:23:58 +09:00
Takeshi KOMIYA	52ed9ef3a0	Closes #2157: helper function `warning()` for HTML themes is added	2018-03-19 00:18:10 +09:00
jfbu	bde42595c6	Update installation docs	2018-03-17 22:56:53 +01:00
Takeshi KOMIYA	9efaf18852	Merge branch '1.7'	2018-03-18 01:21:01 +09:00
shimizukawa	e3470bbde3	fix #4734: Describe how to specify make.bat parameter on Windows	2018-03-16 16:19:39 +09:00
Takeshi KOMIYA	b3cbfc2bb5	Update deprecation list	2018-03-15 01:57:39 +09:00
Takeshi KOMIYA	e2f481c956	Merge branch '1.7'	2018-03-03 20:03:45 +09:00
Takeshi KOMIYA	d7bfef13bf	Merge pull request #4690 from tk0miya/1598_awesome_sphinxdoc ... doc: Add a reference to awesome-sphinxdoc	2018-03-03 01:26:27 +09:00
Takeshi KOMIYA	c0a6795a0f	Merge pull request #4590 from stephenfin/doc-rework ... Doc rework (user guide, part 2)	2018-03-02 01:59:51 +09:00
Takeshi KOMIYA	bd898be3fc	doc: Add deprecation list ... So far, deprecated APIs are only listed as CHANGES entry. But they are not listed in one place. In this change, I gathered them to docs as a list. As a side effect, it makes CHANGES entry simple.	2018-03-02 00:01:49 +09:00
Takeshi KOMIYA	278577c2ef	Merge branch 'master' into improve_i18n	2018-03-01 23:38:38 +09:00
Takeshi KOMIYA	7841de4a26	doc: Add a reference to awesome-sphinxdoc	2018-03-01 00:46:36 +09:00
Stephen Finucane	ff579b3c66	doc: Add "quickstart" doc to usage guide ... This is simply the former 'tutorial' document renamed. A number of references need to be updated, so this is done. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-02-26 11:36:46 +00:00
Stephen Finucane	4bc03706e8	doc: Rework "tutorial" document ... We're going to use this document as the basis for a future usage document, so we start by cleaning things up beforehand. A couple of changes are necessary: - The installation guide is referenced, rather than duplicating the steps In addition, there is 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-02-26 11:36:36 +00:00
Takeshi KOMIYA	b3e7609a80	Update docs	2018-02-25 23:44:38 +09:00
Takeshi KOMIYA	6e89c7c906	Merge pull request #4671 from TimKam/4244-show-intersphinx-db ... Document: showing links & targets of Intersphinx mapping file	2018-02-25 11:32:55 +09:00
Timotheus Kampik	e464f6f135	#4188 update quickstart doc	2018-02-24 17:45:00 +01:00
Timotheus Kampik	20dcbd367d	#4244 use more generic Python *3* examples	2018-02-24 16:45:04 +01:00
Timotheus Kampik	7aaba1758a	#4244 docs: showing links & targets of Intersphinx mapping	2018-02-24 16:30:09 +01:00
Timotheus Kampik	3700a24e1a	#4244 update Python version in intersphinx doc examples	2018-02-24 16:03:01 +01:00
Takeshi KOMIYA	f6b1abf254	Merge pull request #4594 from tk0miya/4564_rst_prolog_not_working ... Change interface of add_source_parser() and add add_source_suffix()	2018-02-22 20:19:13 +09:00
ederag	359050d88c	Typo: cocstring => docstring	2018-02-21 21:04:54 +01:00
Takeshi KOMIYA	5789b25847	Change interface of add_source_parser() and add add_source_suffix()	2018-02-21 10:54:49 +09:00
Takeshi KOMIYA	4a03c5eeba	doc: create htmlhelp section	2018-02-19 10:37:06 +09:00
Aaron Carlisle	8ef71551cb	Docs: Templating: Small wording fix	2018-02-16 18:58:47 -05:00
Stephen Finucane	cb4b7177d8	doc: Create usage guide section ... Start structuring our docs a little better starting with a usage guide. There are a number of changes happening here. We're going to start with the installation guide, which is simply moved to the appropriate subdirectory. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-02-10 16:22:44 +00:00
Stephen Finucane	4fa7d6037c	doc: Rework "install" document ... This is a large rework of the installation guide. There are a couple of changes necessary: - 'Mac OSX' is replaced by 'macOS' - PyPI installation steps are moved to their own section - Instructions are no longer provided for installing Python on Windows: instead, we refer to the other, better-maintained guides. In addition, 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-02-10 16:22:40 +00:00
Danish Prakash	0fe14c3e3b	potential typo ... `You can also download PDF/EPUB versions of the Sphinx documentation: a PDF version generated from the LaTeX Sphinx produces, and an EPUB version.` Either a typo or maybe wrong sentence structure.	2018-02-06 11:09:48 +05:30
Takeshi KOMIYA	4647fcee45	Merge branch '1.7-release'	2018-01-31 20:40:56 +09:00
Takeshi KOMIYA	9a1de16b90	Merge branch 'master' into register_author_as_confval	2018-01-31 01:46:03 +09:00
Takeshi KOMIYA	a5fea73d0c	Merge branch 'master' into integrate_source_suffix_and_source_parsers	2018-01-31 00:04:11 +09:00
Takeshi KOMIYA	8b070366e2	Add links to HTML themes index	2018-01-30 23:40:00 +09:00
Takeshi KOMIYA	41769f1e30	config: epub_authr and epub_publisher refers author by default	2018-01-29 23:29:57 +09:00
Takeshi KOMIYA	23741ca693	Add :confval:author as a configuration value	2018-01-29 23:29:54 +09:00
Takeshi KOMIYA	0010179d45	docs: Add description for attributes of Builder (refs: #4402)	2018-01-29 22:41:06 +09:00
Takeshi KOMIYA	0f4a4b2ae9	Merge pull request #4486 from tk0miya/4460_env_version_of_extensions ... Close #4460: extensions should return the version of data structure as metadata	2018-01-28 21:15:07 +09:00
Takeshi KOMIYA	686de7dfff	Merge branch 'master' into drop_rst2pdf_support	2018-01-28 19:23:18 +09:00
Takeshi KOMIYA	9f5c676322	Use flake8-import-order	2018-01-28 01:52:16 +09:00
Takeshi KOMIYA	53096a35d8	doc: Fix typo	2018-01-26 01:29:52 +09:00
Takeshi KOMIYA	32c5e8346f	Close #4460: extensions should return the version of data structure as metadata	2018-01-25 02:04:22 +09:00
Takeshi KOMIYA	69f69628ed	:confval:source_suffix allows a mapping fileext to file types	2018-01-25 02:03:56 +09:00
Takeshi KOMIYA	dc45877d3c	Deprecate config value: source_parsers	2018-01-25 02:03:56 +09:00
Takeshi KOMIYA	cfd9528879	Merge pull request #4466 from kurtmckee/update-install-docs ... Update install docs	2018-01-22 00:12:17 +09:00
Stephen Finucane	487480ca01	doc: Add 'is_parallel_allowed' ... This is an important function and should be documented. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-21 11:37:59 +00:00
Stephen Finucane	6c23dac5a6	doc: Reorder 'sphinx.application' docs to match code ... Use the same ordering to minimize cognitive load. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-21 11:19:52 +00:00
Stephen Finucane	b7ff955472	doc: Move 'sphinx.application' API docs to code ... This allows us to do something like 'help(sphinx.application)' in code. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-21 11:19:46 +00:00
Stephen Finucane	eaaab75ec2	doc: Rework 'sphinx.application' API documentation ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-21 10:49:38 +00:00
Takeshi KOMIYA	9a3f401c46	Merge branch '1.7-release'	2018-01-21 16:07:14 +09:00
Takeshi KOMIYA	6e420e517e	Merge pull request #4465 from tk0miya/improve_config ... Improve config	2018-01-21 16:05:34 +09:00
Takeshi KOMIYA	eaa44779d5	Merge branch '1.7-release' into sphinx-build-set-proc-count-to-cpu-count	2018-01-21 15:43:17 +09:00
Takeshi KOMIYA	1c3865b190	Merge pull request #4469 from kurtmckee/use-https-urls ... Use HTTPS URL's	2018-01-21 13:11:12 +09:00
Stephen Finucane	78a44b5825	doc: Resolve inconsistent 'sphinx-apidoc' docs ... The signature for the 'sphinx-apidoc' call differs between the man page and the output of 'sphinx-apidoc --help'. Resolve this by considering the 'sphinx-apidoc --help' output the canonical reference. Signed-off-by: Stephen Finucane <stephen@that.guru> Fixes: #4451	2018-01-20 23:02:18 +00:00
Kurt McKee	beefd445c1	Convert doc HTTP links to HTTPS, even in documentation examples ... A small number of URL's redirected, or were stale but had obvious alternatives. These have been updated. For example, a Google style guide for Python was no longer available at googlecode.com, and Paver docs are now at readthedocs.io.	2018-01-20 16:50:35 -06:00
Kurt McKee	c0ffcba9e2	Update the screenshots and docs to match the Python website and installer ... The instructions for installing pip are no longer relevant and have been removed. The instructions for modifying the PATH are no longer relevant and have been removed. The final section, "Installing Sphinx with pip", is now a subsection of the Windows install instructions. The verb tense has been modified to match the rest of the instructions. The command line examples have been converted to use the Pygments text lexer instead of the batch lexer, which highlights everything after `>` incorrectly.	2018-01-20 10:07:56 -06:00
Kurt McKee	3620d85b80	Update the Sphinx version to 1.6	2018-01-20 09:59:50 -06:00
Kurt McKee	f70fcabb7c	Update the MacPorts URL to use HTTPS	2018-01-20 09:57:28 -06:00
Stephen Finucane	b215f523f7	doc: Move sphinx.logging API docs to code ... Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-20 13:00:43 +00:00
Stephen Finucane	b7749c6ca3	doc: Move sphinx.config API docs to code ... Once again, we make things a little smarter by using Python domain roles. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-20 12:53:45 +00:00
Stephen Finucane	391cd8195b	doc: Move sphinx.errors API docs to code ... This allows us to do something like 'help(sphinx.errors)' in code. We reword the exception descriptions per Python stdlib conventions. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-20 12:47:49 +00:00
Takeshi KOMIYA	a331e90c87	doc: Remove mentions to rst2pdf	2018-01-20 21:33:09 +09:00
Takeshi KOMIYA	29df3a095a	Add config-inited event	2018-01-20 21:21:45 +09:00
Takeshi KOMIYA	ae620e16f7	doc: Fix typo	2018-01-20 21:09:51 +09:00
deoren	c808b4b8db	minor typo	2018-01-16 15:09:45 -06:00
Takeshi KOMIYA	1d0a087f75	Merge branch 'master' into body-width	2018-01-15 10:19:01 +09:00
Takeshi KOMIYA	18dfe37f8c	Enable text_add_secnumbers by default (refs: #4218)	2018-01-15 00:37:32 +09:00
Takeshi KOMIYA	b688941b09	Merge branch 'master' into feature-text-secnumbers	2018-01-15 00:21:50 +09:00
Takeshi KOMIYA	c399357f38	Show a notice if both tabularcolumns and :widths: are given (refs: #4196)	2018-01-14 22:23:18 +09:00
Takeshi KOMIYA	cdb31585a8	Merge branch 'master' into sphinx-build-set-proc-count-to-cpu-count	2018-01-14 09:39:48 +09:00
Takeshi KOMIYA	decbf20ccf	Merge pull request #4354 from stephenfin/builder-success-message ... Add 'Builder.epilog' attribute	2018-01-13 18:39:29 +09:00
Takeshi KOMIYA	840b5828e7	docs: Add `-j auto` option	2018-01-13 15:50:26 +09:00
Takeshi KOMIYA	7e365d97ac	Merge pull request #4235 from anarcat/manpage-links ... add link to manpages in HTML builder	2018-01-13 14:28:11 +09:00
Takeshi KOMIYA	f5b1aff2d1	Merge branch 'master' into 4183_follow_pep440	2018-01-13 13:12:32 +09:00
Takeshi KOMIYA	12a8d5c0bd	doc: make looks understandable	2018-01-13 11:09:27 +09:00
Takeshi KOMIYA	76c5395c5b	Merge remote-tracking branch 'atodorov/inheritance_top_class'	2018-01-13 11:08:31 +09:00
deoren	32aa664bdf	Small label/comma fix	2018-01-11 15:19:04 -06:00
Stephen Finucane	a83e8bab7d	builders: Add 'Builder.epilog' option ... This allows builders to emit a final epilog message containing information such as where resulting files can be found. This is only emitted if the build was successful. This allows us to remove this content from the 'make_mode' tool and the legacy 'Makefile' and 'make.bat' templates. There's room for more dramatic simplification of the former, but this will come later. Signed-off-by: Stephen Finucane <stephen@that.guru>	2018-01-11 20:57:03 +00:00
Antoine Beaupré	90f7c7ef3f	add link to manpages in HTML builder ... It is useful to have the HTML documentation builder actually link to real rendered versions of HTML manpages in its output. That way people can click on manpages to get the full documentation. There are a few services offering this online, so we do not explicitly enable one by default, but the Debian manpages repository has a lot of the manpages pre-rendered, so it is used as an example in the documentation. The parsing work is done by a transformer class that parses manpage objects and extract name/section elements. Those then can be used by writers to cross-reference to actual sites. An implementation is done in the two HTML writers, but could also apply to ePUB/PDF writers as well in the future. This is not enabled by default: the `manpages_url` configuration item needs to be enabled to point to the chosen site. The `page`, `section` and `path` parameters are expanded through Python string formatting in the URL on output. Unit tests are fairly limited, but should cover most common use-cases.	2018-01-11 13:20:34 -05:00
Takeshi KOMIYA	38857f97af	Merge pull request #4388 from tk0miya/master ... stable to master	2018-01-08 21:07:16 +09:00
Takeshi KOMIYA	b6e38b4065	Merge pull request #4310 from tk0miya/refactor_AutoDirective ... Refactor AutoDirective	2018-01-08 14:38:47 +09:00
Takeshi KOMIYA	1c0a5ee55d	Merge branch 'master' into refactor_AutoDirective	2018-01-08 14:17:08 +09:00
Takeshi KOMIYA	7ba54500fc	Fix #4183: doctest: `:pyversion:` option also follows PEP-440 specification	2018-01-08 11:59:50 +09:00
Jon Dufresne	cc3abba171	Prefer https & readthedocs.io instead of readthedocs.org for links ... Read the Docs moved hosting to readthedocs.io instead of readthedocs.org. Fix all links in the project. For additional details, see: https://blog.readthedocs.com/securing-subdomains/ > Starting today, Read the Docs will start hosting projects from subdomains on > the domain readthedocs.io, instead of on readthedocs.org. This change > addresses some security concerns around site cookies while hosting user > generated data on the same domain as our dashboard.	2018-01-07 09:10:27 -08:00