Commit Graph

10469 Commits

Author SHA1 Message Date
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
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
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
ac41ca3413 Remove from CHANGES extra line (refs: #4741) 2018-03-30 22:54:47 +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
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
jfbu
1460e261fa Update CHANGES for PR #4793 2018-03-29 23:49:48 +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
jfbu
2e74ab0baf Update CHANGES for PR #4796 2018-03-29 19:16:45 +02:00
Jean-François B
14bef5d8ca
Merge pull request #4796 from jfbu/latex_fix_mangled_template_path
Fix broken LateX customization via templates (closes: #4795)
2018-03-29 19:00:10 +02: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
b25f7ee137 Use builder.confdir as prefix to user latex templates 2018-03-29 15:34:37 +02:00
jfbu
415126d42f Fix LaTeX style file version number
(I should perhaps have left it standing, as this may cause merge
conflicts if merged after long delay)
2018-03-29 15:28:26 +02: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
d16c7a196f
Merge pull request #4788 from tk0miya/4787_update_docs
Fix #4787: Update docstrings for add_directive()
2018-03-29 22:06:39 +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
jfbu
38dc048bce Fix broken LateX customization via templates (closes: #4795) 2018-03-29 14:58:32 +02: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
jfbu
bf911b9f40 Update CHANGES for PR #4792 2018-03-28 22:56:22 +02:00
Jean-François B
3259ba9422
Merge pull request #4792 from jfbu/autosummary_latex_tablespec
Fix autosummary latex table colspec (closes #4790)
2018-03-28 22:40:32 +02:00
jfbu
c59a0ccae1 Fix autosummary latex table colspec (closes #4790) 2018-03-28 10:03:18 +02:00
Takeshi KOMIYA
045e8c80f3
Merge pull request #4781 from tk0miya/drop_env._nitpick_ignore
Deprecate env._nitpick_ignore
2018-03-27 23:43:24 +09:00
Takeshi KOMIYA
dfe20f116a
Merge pull request #4780 from tk0miya/drop_TYPE_CHECKING_in_master
Drop typing.TYPE_CHECKING
2018-03-27 23:42:58 +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
aa1073cfe1 Fix #4787: Update docstrings for add_directive() 2018-03-27 23:10:22 +09:00
Takeshi KOMIYA
e2d2a9ab7b
Merge pull request #4774 from tk0miya/4769_argument_for_staticmethods
Fix #4769: autodoc loses the first staticmethod parameter
2018-03-27 09:47:11 +09:00
Takeshi KOMIYA
0f3fa689a4 Deprecate env._nitpick_ignore 2018-03-26 02:05:58 +09:00
Takeshi KOMIYA
f9ae69d9b0 Drop typing.TYPE_CHECKING 2018-03-26 02:02:19 +09:00