Takeshi KOMIYA
a033d53c24
Close #7032 : html_scaled_image_link is disabled for individual image
2020-02-18 01:48:11 +09:00
sethg
28ad370343
Add option to docs
2020-02-16 21:37:41 +01:00
Takeshi KOMIYA
24b9efb65e
doc: Update usage/quickstart.rst to adjust latest quickstart
2020-02-17 02:12:27 +09:00
Neal McBurnett
b620a8a6cc
Fix typos
...
bad quoting, better word usage.
2020-02-09 19:12:52 -07:00
Neal McBurnett
9b125cf8e9
Clarify documentation on use of doctest extension
...
When I first read this section, I was mightily confused due to lack of context and the use of the passive voice.
I think this phrasing clarifies the context and indicates more clearly what the documentation author does
vs what the doctest extension and builder do.
But I'm a newbie here, so please ensure that I got this right....
2020-02-09 16:59:39 -07:00
Takeshi KOMIYA
2e87ee85a2
Merge branch '2.0'
2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
1e5342faa9
Merge pull request #7109 from sphinx-doc/6033_doc_for_tocdepth
...
docs: Add a restriction note about tocdepth (refs: #6033 )
2020-02-08 18:37:06 +09:00
Takeshi KOMIYA
f6acd061f3
docs: Add a restriction note about tocdepth (refs: #6033 )
2020-02-07 23:59:20 +09:00
Matthias Geier
327778ca22
Disable arrow keys when a modifier key is pressed ( #7089 )
...
* Disable arrow keys when a modifier key is pressed
Closes #7088 .
* #7088 document key navigation option
* add change note for #7088
Co-authored-by: Timotheus Kampik <timotheus.kampik@signavio.com>
2020-02-07 13:08:51 +01:00
Takeshi KOMIYA
0c0d037059
Merge pull request #7083 from tk0miya/update_docs
...
doc: Make desc of gettext_additional_targets easy to read
2020-02-01 13:39:21 +09:00
Takeshi KOMIYA
423a7a7131
doc: Make desc of gettext_additional_targets easy to read
2020-02-01 13:12:32 +09:00
Takeshi KOMIYA
179a1f9cc2
py domain: Support type annotations for variables
...
This adds ``:type:`` and ``:value:`` options to both ``py:data``
and ``py:attribute`` directives. It allows to describe its
annotation in detail.
2020-02-01 12:58:27 +09:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Jakob Lykke Andersen
9fa23615ec
Fixes from review
2020-01-25 17:02:59 +01:00
Takeshi KOMIYA
5397664d42
Add a new extension: sphinx.ext.autodoc.typehints
2020-01-25 17:56:39 +09:00
Jakob Lykke Andersen
c084c3f124
Implement scoping for productionlist
...
Fixes sphinx-doc/sphinx#3077
2020-01-22 22:32:30 +01:00
Takeshi KOMIYA
347e301727
Merge branch '2.0'
2020-01-19 22:47:02 +09:00
Takeshi KOMIYA
74a5f350a1
Add new event: autodoc-before-process-signature
2020-01-13 13:16:59 +09:00
Takeshi KOMIYA
f169560395
Merge pull request #6979 from tk0miya/6830_autodoc_private
...
Close #6830 : autodoc: consider a member private if docstring contains :private:
2020-01-11 15:14:52 +09:00
Takeshi KOMIYA
cad1f86dd8
Merge branch '2.0'
2020-01-11 02:56:58 +09:00
Ralf Gommers
659c66ad98
Update documentation of download role for addition of hash in subdir
...
This was changed in gh-5377, but that forget the (now slightly
misleading) documentation.
Discovered in https://github.com/numpy/numpy.org/pull/14 , where
we were relying on download links being stable.
2020-01-07 13:06:16 +01:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
0319faf8f1
Merge branch '2.0'
2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
2f36d792f3
Update CHANGES for PR #5230
2020-01-01 12:59:20 +09:00
Takeshi KOMIYA
e628afd5cd
Merge branch '2.0'
2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
7851550cd8
doc: Fix ambiguous confval entries and references
2019-12-29 23:23:46 +09:00
Takeshi KOMIYA
18e25d680d
Close #6966 : graphviz: Support `:class:` option
2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
1fc4e8c251
Merge branch '2.0'
2019-12-25 22:44:12 +09:00
Takeshi KOMIYA
de9ee3e70a
doc: Fix sphinx.ext.duration will be added since 2.4.0
2019-12-25 22:43:56 +09:00
Takeshi KOMIYA
e83bb29789
Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass
...
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-22 16:30:56 +09:00
Takeshi KOMIYA
a209002b81
doc: Add examples for :inherited-members:
2019-12-22 16:05:45 +09:00
Takeshi KOMIYA
d47f38e22d
Merge branch '2.0'
2019-12-21 12:21:49 +09:00
Takeshi KOMIYA
29687a29f1
Close #6446 : Add sphinx.ext.durations to inspect durations of build
2019-12-16 00:47:23 +09:00
Takeshi KOMIYA
712c20a3d9
Merge branch '2.0'
2019-12-16 00:05:35 +09:00
Damien Ayers
1a54a7229c
Fix documentation typo
...
(cherry picked from commit 937c684960
2019-12-13 23:27:04 +01:00
Damien Ayers
937c684960
Fix documentation typo
2019-12-13 12:33:02 +11:00
jfbu
2199a127e8
Typo (refs #6491 )
2019-12-09 22:57:45 +01:00
Takeshi KOMIYA
7ec567b6d0
Merge branch '2.0'
2019-12-09 00:13:42 +09:00
Takeshi KOMIYA
9e40f2a603
doc: rewrite options for code-block by directive:option directive
2019-12-08 21:33:06 +09:00
Takeshi KOMIYA
d82e0bb5a5
doc: rewrite options for highlight by directive:option directive
2019-12-08 21:33:06 +09:00
Takeshi KOMIYA
fb9adbf0be
Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth
...
Update docs about intersphinx and basic auth support
2019-12-03 01:42:37 +09:00
Takeshi KOMIYA
7292ab7eef
Merge branch '2.2.2' into 2.0
2019-12-03 01:19:02 +09:00
Santos Gallegos
46c68302be
Be more specific about the type of login
2019-12-02 11:07:17 -05:00
Takeshi KOMIYA
7c79a6b8d1
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-01 12:51:28 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
82a6048f12
Fix typo
2019-11-28 23:31:08 +09:00
Santos Gallegos
f7c1e9190a
Linter
2019-11-27 15:38:26 -05:00
Santos Gallegos
a72d8f6808
Update docs about intersphinx and basic auth support
...
This was added in #2089 but the docs don't mention it.
2019-11-27 15:23:52 -05:00
Takeshi KOMIYA
1cc1481771
Merge pull request #6866 from tk0miya/napoleon_doc_fix
...
doc: URL of numpydoc has changed
2019-11-27 01:25:33 +09:00
Takeshi KOMIYA
82b2b1752a
doc: URL of numpydoc has changed
2019-11-27 00:12:32 +09:00
Takeshi KOMIYA
9bd64e4e2a
Merge pull request #6862 from tk0miya/6854_update_supported_languages_list
...
Update supported languages (refs: #6854 )
2019-11-27 00:04:22 +09:00
jfbu
dc53404d48
Fix markup issue in our docs
2019-11-26 14:22:17 +01:00
jfbu
d398959230
Fix typo in docs
2019-11-26 14:11:40 +01:00
Takeshi KOMIYA
995dfa4e73
Merge pull request #6816 from jonashaag/linkcheck-auth
...
Add linkcheck_auth option
2019-11-26 01:29:30 +09:00
Takeshi KOMIYA
1faf14d411
Update supported languages (refs: #6854 )
2019-11-26 01:22:14 +09:00
Takeshi KOMIYA
6de29cdb84
Merge pull request #6854 from jfbu/doc_mention_Greek_as_supported_language
...
DOC: add Greek to list of supported languages
2019-11-26 00:56:34 +09:00
Jonas Haag
df2f80c755
Add linkcheck_auth option
2019-11-25 09:53:45 +01:00
jfbu
70f087990b
DOC: add Greek to list of supported languages
2019-11-22 19:15:59 +01:00
Takeshi KOMIYA
c65243325c
Merge branch '2.0' into 6798_autosummary_emits_skip_member_event
2019-11-21 00:45:57 +09:00
Sylvestre Ledru
3aef93c4a3
Fix the URL to https://pygments.org/docs/lexers.html
2019-11-20 14:49:15 +01:00
Takeshi KOMIYA
c6f0eb215a
Fix #4186 : LaTeX: Support upLaTeX as a new latex_engine (experimental)
2019-11-17 17:37:48 +09:00
Takeshi KOMIYA
6644830941
Merge branch '2.0'
2019-11-17 14:24:04 +09:00
Joe
1fd7176f89
Fix link to pygments lexer
2019-11-16 18:11:14 -08:00
Takeshi KOMIYA
66c3dd3adb
Close #6798 : autosummary: emit `autodoc-skip-member` event on generating stub file
2019-11-16 18:19:31 +09:00
Tetsuo Koyama
7fbd9c02d0
🎨 Fixed issue #6789
2019-11-04 20:28:24 +09:00
Takeshi KOMIYA
32763520a3
Close #1331 : Change default User-Agent header
2019-10-27 02:05:33 +09:00
Takeshi KOMIYA
a6a2a59ab0
Merge branch '2.0'
2019-10-20 13:43:30 +09:00
Takeshi KOMIYA
cb22be80c2
Merge branch '2.2.1' into 2.0
2019-10-20 13:42:10 +09:00
Takeshi KOMIYA
a950df1908
Close #6729 : HTML theme: agogo theme now supports rightsidebar option
2019-10-14 14:26:33 +09:00
jfbu
7be68b7c4b
Add latexpdf support for Greek as main language (via xelatex use)
...
Closes : #6710
2019-10-01 10:27:43 +02:00
Takeshi KOMIYA
01f8dad160
Merge branch '2.0'
2019-08-19 00:37:30 +09:00
ExplorerLog
edff2824e9
Update configuration.rst
...
Add a comma
2019-08-16 16:29:29 +08:00
jfbu
4ae5414ee5
Update our docs for imgmath_latex (refs: #6610 )
2019-08-03 12:00:24 +02:00
jfbu
47cd262b3e
Merge branch '2.0'
2019-08-01 18:30:48 +02:00
jfbu
7c59e44eaa
Fix version changed info in our document for imgmath
2019-08-01 18:24:28 +02:00
jfbu
da3763170e
Reorganize documentation of the imgmath configuration variables
2019-08-01 17:52:28 +02:00
jfbu
505ff622c2
More robust code for getting saved "depth" of svg inline math snippet
2019-08-01 17:52:28 +02:00
jfbu
1adf12bfa7
Make imgmath_use_preview work also for svg output
2019-08-01 17:52:28 +02:00
Timotheus Kampik
0662a3ecd6
#6503 document meta directive ( #6562 )
...
#6503 document meta directive
The `meta` directive has partly Sphinx-specific behavior
and hence needs to be documented
2019-07-08 22:48:41 +02:00
woutdenolf
9dc9b8754d
Merge with master and address code review
2019-07-08 08:29:23 +02:00
Takeshi KOMIYA
4af90fcf75
Fix #247 : autosummary: Add autosummary_generate_option to overwrite old stub file
2019-07-07 16:18:49 +09:00
Dull Bananas
e24709c2df
Clarify Windows installation
2019-07-05 18:41:22 -07:00
Takeshi KOMIYA
c18dcf08f9
Merge branch '2.0'
2019-06-30 01:08:48 +09:00
Takeshi KOMIYA
828beb12e0
doc: Update document for :annotation: option (refs: #6495 )
2019-06-29 18:43:30 +09:00
Takeshi KOMIYA
5d42659e33
Merge branch '2.0'
2019-06-15 23:39:44 +09:00
woutdenolf
ec8656bd27
[autosummary] remove recursion limit and module/package separation
2019-06-02 16:26:40 +02:00
Takeshi KOMIYA
ce2f9c2b94
Close #5124 : graphviz: :graphviz_dot: option is renamed to :layout:
2019-06-02 21:33:34 +09:00
Takeshi KOMIYA
c4f44bdd22
Merge branch '2.0'
2019-06-02 21:17:38 +09:00
Takeshi KOMIYA
1303ea7cdf
docs: Use directive:option in extensions/graphviz
2019-06-02 18:18:55 +09:00
Takeshi KOMIYA
5da74898c3
Merge branch '2.0'
2019-06-02 01:09:09 +09:00
Takeshi KOMIYA
4c19ab7058
Merge commit '54d5fcfaebc3364044761d30c0fed6bd4d3052c3'
2019-06-02 01:02:54 +09:00
Takeshi KOMIYA
91fceb4b5f
Merge branch '2.0.2' into 2.0
2019-06-02 00:58:46 +09:00
woutdenolf
4fb58b2146
[autosummary] doclint violation
2019-06-01 13:08:23 +02:00
woutdenolf
140ae00baa
Merge branch 'master' into feature-autosummary-packages
2019-06-01 12:42:28 +02:00
Takeshi KOMIYA
54d5fcfaeb
Merge pull request #6416 from tk0miya/2310_force_highlighting
...
Add :force: option to code directives
2019-06-01 14:17:53 +09:00
Takeshi KOMIYA
e001d358d0
Add :force: option to code directives
2019-06-01 13:42:57 +09:00
Takeshi KOMIYA
c6d840d95a
doc: Change wording for contents directive (refs: #6265 )
2019-06-01 11:27:38 +09:00
Takeshi KOMIYA
ce3c5735cd
Merge branch '2.0'
2019-06-01 01:45:47 +09:00
Takeshi KOMIYA
2afba22cee
Merge pull request #6397 from tk0miya/6361_autodoc_typehints
...
Close #6361 : autodoc: Add autodoc_typehints to suppress typehints from signature
2019-06-01 01:07:37 +09:00
gilch
e7239053b7
Grammar corrections
2019-05-29 19:41:45 -06:00
Takeshi KOMIYA
d6063ff35b
doc: Fold lines by 80 columns
2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
b9d7239d90
Merge branch '2.0'
2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
9b2423c5bb
doclinter: restrict by 90 columns
2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
0ea380eddd
Close #6361 : autodoc: Add autodoc_typehints to suppress typehints from signature
2019-05-26 00:35:24 +09:00
Takeshi KOMIYA
3105feec80
doc: Update with rst:directive:option directive
2019-05-20 00:26:28 +09:00
Takeshi KOMIYA
557d8d140e
Merge pull request #6365 from tk0miya/refactor_py_domain
...
Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc
2019-05-19 23:46:34 +09:00
woutdenolf
1a67b87910
Merge branch 'master' into feature-autosummary-packages
2019-05-18 14:42:34 +02:00
Takeshi KOMIYA
279223065b
Merge branch '2.0' into master
2019-05-17 01:24:45 +09:00
Gibson Fahnestock
6f7cb4da94
autosectionlabel: add type for suppress_warnings
...
This sets the subtype to the filename, which means that you can suppress
warnings for individual paths.
For example for the following warning:
```
path/to/file.rst:5547: WARNING: duplicate label path/to/file:label, other instance in /path/to/file.rst
```
You would add this to `config.py` to suppress all warnings:
```python
extensions = [
'sphinx.ext.autosectionlabel',
]
autosectionlabel_prefix_document = True
suppress_warnings = [
'autosectionlabel.*',
]
```
To suppress warnings for the individual file path you would do:
```python
suppress_warnings = [
'autosectionlabel.path/to/file',
]
```
Fixes: https://github.com/sphinx-doc/sphinx/issues/6371
2019-05-15 19:30:46 +01:00
Adrián Chaves
e84ba7f78a
Support coverage_ignore_pyobjects in the coverage builder
2019-05-15 12:23:05 +02:00
Takeshi KOMIYA
64eacb30a8
Fix modname of HTMLHelpBuilder
2019-05-15 00:08:27 +09:00
Takeshi KOMIYA
358e582490
Add :abstractmethod: option to py:method directive (refs: #6138 )
2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
f63abac2ca
Merge branch '2.0'
2019-05-13 22:03:26 +09:00
Takeshi KOMIYA
416426dfb7
Merge pull request #6356 from tk0miya/foldlines
...
Add utils/doclinter.py; a documenter linter for Sphinx
2019-05-13 14:39:01 +09:00
Takeshi KOMIYA
ca605c7437
Add :type: option for rst:directive:option directive
2019-05-13 14:14:14 +09:00
Takeshi KOMIYA
4307dec3ac
Add rst:directive:option directive
2019-05-13 13:55:56 +09:00
Takeshi KOMIYA
fa00458f4f
docs: Fold lines by 80 chars
2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
a142a654fc
Add :property: option to py:method directive
2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
37a5736a1f
Merge branch '2.0'
2019-05-06 21:09:43 +09:00
jfbu
48ad83d061
Reorganize documentation of the imgmath configuration variables
2019-04-24 12:30:18 +02:00
jfbu
ea28bd9fb0
More robust code for getting saved "depth" of svg inline math snippet
2019-04-24 11:56:19 +02:00
jfbu
3edcff7952
Make imgmath_use_preview work also for svg output
2019-04-23 15:13:21 +02:00
Takeshi KOMIYA
e0abb10792
Fix #4777 : Add :async: option to py:function and py:method directives
2019-04-23 01:40:37 +09:00
Takeshi KOMIYA
a285220778
Merge branch '2.0' into refactor_py_domain2
2019-04-23 01:16:42 +09:00
jfbu
6009140f22
Fix a dvisvgm link in docs and add preview-latex link
2019-04-17 10:07:30 +02:00
Alex Sergeev
98691baf85
Address comments
2019-04-14 10:47:50 -10:00
Alex Sergeev
4bad5bd419
Address feedback
2019-04-13 20:54:20 -10:00
Takeshi KOMIYA
331594e2ca
Add :classmethod: and :staticmethod: options to py:method directive
2019-04-13 23:14:59 +09:00
jfbu
9ecd42574d
Documentation of smartquotes_excludes (and smartquotes_action)
2019-04-12 18:34:10 +02:00
woutdenolf
6e0b0517c0
[autosummary] address code review
2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635
Merge branch 'master' into feature-autosummary-packages
2019-04-07 10:32:57 +02:00
Takeshi KOMIYA
338941a49a
Fix #6213 : ifconfig: contents after headings are not shown
2019-04-05 02:34:23 +09:00
Takeshi KOMIYA
005913630f
Add missing versionadded for autosummary_mock_imports
2019-04-04 23:49:43 +09:00
Takeshi KOMIYA
6cb263b9c8
Merge pull request #6212 from tsanikgr/feature/autosummary_imported_members
...
Allow setting imported_members for autosummary in conf.py
2019-04-04 23:04:36 +09:00
tsanikgr
eb03b1406f
Simplify docs
2019-04-03 17:31:16 +01:00
Takeshi KOMIYA
a6ef53083c
Merge pull request #6215 from rkdarst/mathjax-doc-clarification
...
Clarify MathJax extension usage
2019-03-30 00:52:39 +09:00
Richard Darst
277588f2f9
Clarify MathJax extension usage: edits from review
2019-03-29 16:40:18 +02:00
Richard Darst
dd0246c6dc
Clarify MathJax extension usage
...
- We recently hit an issue where we expected the MathJax extension to
work with the default MathJax markup. Obviously that shouldn't be
the case (since then other formats couldn't use the math), but it
can't hurt to include a hint.
- Link from the math HTML extension page to the relevant
roles/directives.
- Also make it explicit that MathJax has a default, and that it's an
external resource that will be dynamically linked.
2019-03-27 18:10:09 +02:00
tsanikgr
bec116a3b6
#5877 : Allow setting imported_members for autosummary in conf.py
2019-03-27 14:19:16 +00:00
Michael Goerz
4e27cc465a
Fix docs of inheritance-diagram "parts" option
...
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)
As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.
Closes #4872
2019-03-19 01:19:29 +09:00
Michael Goerz
1f136215c1
Fix docs of inheritance-diagram "parts" option
...
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)
As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.
Closes #4872
2019-03-10 18:37:05 -04:00
Antony Lee
386ec9cd9a
Fix doc typo.
2019-03-07 14:17:41 +01:00
Takeshi KOMIYA
ba86f4ea78
Merge branch '2.0'
2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
10869289ef
docs: JS domain does not support reset current module
2019-03-03 14:56:38 +09:00
Takeshi KOMIYA
01f46111c5
Merge branch '2.0'
2019-03-02 18:38:24 +09:00
Takeshi KOMIYA
ceef713e79
docs: Remove a term "new" from config values
2019-02-27 01:18:57 +09:00
Takeshi KOMIYA
51db9358fc
Merge pull request #6048 from stephenfin/doc-rework-tutorials
...
Doc rework (development guide, part 1)
2019-02-26 22:51:55 +09:00
woutdenolf
33e7b76c32
Merge branch 'master' into feature-autosummary-packages
2019-02-24 12:16:52 +01:00
woutdenolf
cb51216cac
[autosummary] modify docs
2019-02-24 12:12:33 +01:00
Takeshi KOMIYA
9548b06d02
docs: Add a tip about $REQUESTS_CA_BUNDLE
2019-02-24 20:03:21 +09:00
Takeshi KOMIYA
1ca210aab1
Separate json and pickle to sphinxcontrib package
2019-02-17 22:31:50 +09:00
Takeshi KOMIYA
5437ab61e9
Merge pull request #6074 from tk0miya/1148_autodecorator
...
Closes #1148 : autodoc: Add autodecorator directive for decorators
2019-02-16 21:45:36 +09:00
Takeshi KOMIYA
1ece29597e
Merge branch 'master' into simplify_conf.py
2019-02-16 21:25:21 +09:00
Takeshi KOMIYA
686486498c
Closes #1148 : autodoc: Add autodecorator directive for decorators
2019-02-15 02:14:38 +09:00
Takeshi KOMIYA
550c88f98c
Merge pull request #6064 from tk0miya/5636_add_autosummary_mock_imports
...
Closes #5635 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-14 01:13:04 +09:00
Takeshi KOMIYA
1dfddb52ff
Merge pull request #6063 from tk0miya/4261_autosectionlabel_max_depth
...
Add autosectionlabel_max_depth config option
2019-02-14 01:12:05 +09:00
Takeshi KOMIYA
73b8d6ff33
Closes #5636 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-11 23:19:25 +09:00
Takeshi KOMIYA
9f3feb6315
docs: autosectionlabel_maxdepth
2019-02-11 18:21:41 +09:00
Takeshi KOMIYA
a3cdd465ec
HTML builder outputs HTML5 by default
2019-02-11 17:46:56 +09:00
Takeshi KOMIYA
e0ca116057
docs: Update location of builders
2019-02-11 13:46:32 +09:00
Takeshi KOMIYA
057ef31182
Fix typo
2019-02-11 13:25:24 +09:00
Takeshi KOMIYA
54be6ae494
Merge pull request #6053 from tk0miya/5459_autodoc_default_options_accepts_True
...
Closes #5459 : autodoc: autodoc_default_options accepts True as a value
2019-02-11 12:48:43 +09:00
Takeshi KOMIYA
37ce1eb3b3
docs: githubpage now supports CNAME file
2019-02-11 12:46:35 +09:00
Takeshi KOMIYA
b0148c6921
Closes #5459 : autodoc: autodoc_default_options accepts True as a value
2019-02-11 02:03:09 +09:00
Stephen Finucane
b1ebdcd3c6
doc: Add "recipe" tutorial
...
This is based on a post from opensource.com [1] and demonstrates how one
can use indexes for cross-referencing and domains to group these indexes
along with domains and roles. The source code was taken from [2] after
getting the license changed [3].
[1] https://opensource.com/article/18/11/building-custom-workflows-sphinx
[2] https://github.com/ofosos/sphinxrecipes
[3] https://github.com/ofosos/sphinxrecipes/issues/1
Signed-off-by: Stephen Finucane <stephen@that.guru>
2019-02-09 17:58:30 +00:00
Takeshi KOMIYA
319adefa9f
epub: `epub_title defaults to the project` option
2019-02-09 15:00:27 +09:00
woutdenolf
555e675947
[autosummary] add modules and packages for modules
2019-02-08 16:10:43 +01:00
Takeshi KOMIYA
ff80d2f538
Merge pull request #5983 from tk0miya/separate_applehelp
...
Separate applehelp to sphinxcontrib package
2019-02-06 01:14:02 +09:00
Takeshi KOMIYA
c4397318d3
Separate applehelp to sphinxcontrib package
2019-02-06 00:44:37 +09:00
Takeshi KOMIYA
6ca669295c
Close #1851 : Allow to omit an argument for code-block directive
2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
e0e3ba4d91
doc: Fix indentation
2019-02-04 01:31:30 +09:00
Takeshi KOMIYA
4b9e80bdb1
Merge pull request #5970 from tk0miya/separate_devhelp
...
Separate devhelp to sphinxcontrib package
2019-01-25 01:28:13 +09:00
Frank Erens
9e6fe21c6a
Add 'cpp:struct' directive and 'cpp:struct' role.
...
They are cosmetic variants of the class directive/role.
2019-01-20 12:29:20 +01:00
Jakob Lykke Andersen
4e6dacd81b
C++, add some missing .. versionadded directives.
2019-01-20 12:28:57 +01:00
Takeshi KOMIYA
2bd69350a7
Separate devhelp to sphinxcontrib package
2019-01-20 03:03:50 +09:00
Takeshi KOMIYA
6be9d2a08e
Separate qthelp to sphinxcontrib package
2019-01-19 16:34:06 +09:00
Jakob Lykke Andersen
d6b7aad138
C++, alias directive
...
See sphinx-doc/sphinx#4981
2019-01-12 12:57:45 +01:00
Jean-François B
a8feb0bec8
Merge pull request #5919 from jfbu/latex_docs
...
[DOC] Move description of latex_elements to latex.rst
2019-01-12 11:05:50 +01:00
Takeshi KOMIYA
6e21598cea
Merge pull request #5926 from tk0miya/update_docs
...
Fix doc: html_baseurl was added in 1.8.0
2019-01-12 15:09:17 +09:00
Takeshi KOMIYA
b535e13235
Fix doc: html_baseurl was added in 1.8.0
2019-01-12 13:16:31 +09:00
jfbu
ad8205bb0b
[DOC] Move description of latex_elements to latex.rst
2019-01-10 16:48:03 +01:00
Timotheus Kampik
14b67a0464
Update Markdown doc ( #5913 )
...
* update Markdown doc
after relase of ecommonmark version 0.5.0
2019-01-09 16:44:00 +01:00
Jon Dufresne
f1e41a616c
Remove outdated fallback to 'import Image'
...
The fallback 'import Image' was added in commit
99621d7a01https://github.com/python-pillow/Pillow
Old PIL website: http://www.pythonware.com/products/pil/
2019-01-07 06:44:35 -08:00
jfbu
58f4c658fa
Capitalize the Internet
2018-12-29 18:54:06 +01:00
jfbu
32d57b8637
Merge branch '1.8'
...
resolved Conflicts:
doc/development/tutorials/todo.rst
sphinx/locale/__init__.py
sphinx/search/zh.py
2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc
Fix various spelling typos
2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
f811e4cea6
Merge pull request #5859 from tk0miya/fix_doc_for_viewcode_follow_imported_members
...
doc: Fix description for viewcode_follow_imported_members
2018-12-26 01:26:52 +09:00
Takeshi KOMIYA
b229c1a672
Merge pull request #5224 from TimKam/5216-update-markdown-doc
...
#5216 update Markdown config doc to API changes
2018-12-24 12:27:26 +09:00
Timotheus Kampik
3addad5f2a
Merge branch 'master' into 5216-update-markdown-doc
2018-12-23 17:31:01 +01:00
Timotheus Kampik
90181a16ed
#5216 fix removal note
2018-12-23 17:28:44 +01:00
Timotheus Kampik
9583290653
#5216 add note regarding recommonmark version
2018-12-23 17:27:54 +01:00
Takeshi KOMIYA
5b2befe97d
doc: Fix description for viewcode_follow_imported_members
2018-12-23 22:13:33 +09:00
Jon Dufresne
4e184754c9
Remove instructions to install Python 2 on Windows
...
As only Python 3 is supported, should not advise users to install Python
2.
2018-12-23 04:00:26 -08:00
jfbu
701b39328f
Merge branch '1.8'
...
(Resolved) Conflicts:
sphinx/texinputs/sphinxmanual.cls
2018-12-23 11:23:04 +01:00
Timotheus Kampik
20c9489828
#5216 change recommonmark installation instruction
...
the pypi package has not been updated since January 2016;
it is better to install from source
2018-12-23 10:43:39 +01:00
jfbu
1920d1d950
LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage`
...
Closes : #5849
2018-12-21 21:38:27 +01:00
Jean-François B
696c8f0fc0
Merge pull request #5693 from jfbu/latex_doc_unicode_in_math
...
LaTeX (doc): explain how to allow Unicode input in math
2018-12-20 20:31:31 +01:00
jfbu
fdb6147555
LaTeX (doc): explain how to allow Unicode input in math
...
Closes : #5249
2018-12-20 19:43:50 +01:00
Takeshi KOMIYA
a1976cc0c8
Update docs
2018-12-19 01:32:26 +09:00
Jon Dufresne
bade33c7e4
Remove unnecessary encoding cookie from Python source files
...
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:
https://docs.python.org/3/howto/unicode.html#the-string-type
> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...
Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
2018-12-16 12:22:12 -08:00
jfbu
7364e0c2fd
Update docs for LuaLaTeX
2018-12-15 15:16:43 +01:00
Jean-François B
661fb1de59
LaTeX: use Bjarne option of fncychap also if language is set to 'en' ( #5776 )
...
Closes : #5772
2018-12-15 11:37:56 +01:00
jfbu
022fc9d3b6
LaTeX: use `\small` fontsize in code-blocks with xelatex and lualatex
2018-12-13 15:00:38 +01:00
Takeshi KOMIYA
e527be396a
Merge pull request #5607 from tk0miya/smart_texinfo_conf_py
...
quickstart: Simplify generated conf.py (for texinfo)
2018-12-02 01:30:51 +09:00
Jean-François B
8412bdf9d6
Merge pull request #5645 from jfbu/latex_greek_cyrillic_letters
...
LaTeX: support for Greek and Cyrillic
2018-11-21 23:11:15 +01:00
jfbu
1edf2a45b9
LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeX
2018-11-21 22:21:02 +01:00
jfbu
6283324b1a
Load CMU by filename, not font name, for XeLaTeX
2018-11-17 01:46:18 +01:00
jfbu
2825e338c2
LaTeX: support for Greek and Cyrillic
...
0. do not escape Unicode Greek letters via LaTeX math mark-up: pass them
through un-modified to LaTeX document,
1. if "fontenc" receives extra option LGR, then pdflatex will support
Unicode Greek letters (not in math), and with extra option T2A it
will support (most) Unicode Cyrillic letters.
2. for pdflatex with LGR, this will use "textalpha" LaTeX package and
"substitutefont" package to set up some automatic font substitution
to work around the unavailability of Greek with "times"
package (which is default font package chosen by Sphinx for
pdflatex), same with T2A and "substitutefont" for Cyrillic.
3. for xelatex/lualatex, set up Computer Modern Unicode as default font,
as it supports Cyrillic and Greek scripts,
4. for platex, don't do anything special as the engine already has
its default font supporting Cyrillic and Greek (even in math mode!)
Closes : #5251
Fixes: #5248
Fixes: #5247
2018-11-16 21:14:51 +01:00
Stephen Finucane
1c07f0004f
doc: Add "theming" to usage guide
...
This one is a little unusual. The current theming doc mixes user-focused
documentation with developer-focused documentation. This is confusing
and unnecessary. Resolve the issue by splitting the doc in two. The
user-focused docs are moved to the advanced section of the usage guide,
while the developer docs remain where they are, pending the addition of
a developer guide.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 15:23:33 +01:00
Stephen Finucane
71e8477597
doc: Add "websupport" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:23:06 +01:00
Stephen Finucane
23afd29cbb
doc: Add "setuptools" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:22:38 +01:00
Stephen Finucane
d380617c3b
doc: Add "internationalization" to the usage guide
...
This is added to the new "advanced" subsection.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:20:46 +01:00
Takeshi KOMIYA
aeadcdd0b6
doc: Reorder section
2018-11-11 21:57:14 +09:00
Takeshi KOMIYA
00254ea256
Merge pull request #5556 from drewrisinger/drewrisinger-typo-1
...
[Bug]: Typo in Domains.rst
2018-10-25 22:23:26 +09:00
Takeshi KOMIYA
83c50837c1
Merge pull request #5564 from nomis/rst-typo
...
doc: Fix typo of "restructuredtext"
2018-10-25 22:07:00 +09:00
Drew
dc35335a35
[bug]: Correct RST header
...
Have correct amount of "~" for RST heading.
2018-10-24 16:28:11 -04:00
Simon Arlott
7aa750a637
doc: Fix typo of "restructuredtext"
2018-10-24 19:52:42 +01:00
Simon Arlott
f5d4e4207d
doc: Fix typo of "default"
2018-10-24 19:52:24 +01:00
Eric N. Vander Weele
9fcef5030a
autodoc: Respect member-order in autodoc_default_options as documented
...
In the `autodoc_default_options` documentation, it mentions that
`member-order` is respected; however, when setting the key-value pair in
`conf.py`, it is not. Thus, add `member-order` as one of the default
options respected in `conf.py`. Additionally, update the list of
supported options to match the example.
2018-10-16 10:21:18 -07:00
Drew
3812d06544
Update domains.rst
2018-10-10 15:56:29 -04:00
Takeshi KOMIYA
973c3ffa25
Merge branch 'master' into change_master_doc_to_index
2018-09-29 21:12:40 +09:00
Takeshi KOMIYA
ff8df59ac1
Merge pull request #5479 from jdufresne/https
...
Prefer https:// links where available
2018-09-24 09:04:54 +09:00
Jon Dufresne
dd383ec472
Prefer https:// links where available
2018-09-23 11:50:42 -07:00
Jon Dufresne
d9283a40d8
Correct installation docs about supported Python versions
...
Since commit 9412bd76b7
2018-09-23 08:44:29 -07:00
Rob Ruana
e547a6a0d2
Fixes #5426 : [Napoleon] Better handling of inline attributes ( #5470 )
...
* Fixes #5426 : [Napoleon] Better handling of inline attributes
* Removes uneeded NOQA comments
* Fixes imports
2018-09-23 09:26:17 -04:00
Jon Dufresne
490e4aed41
Remove unnecessary object from class definitions
...
In Python 3, all classes are new-style classes. The object in the
definition is redundant and unnecessary.
2018-09-11 07:07:01 -07:00
Takeshi KOMIYA
07fd1c0680
Fix #4018 : htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix
2018-09-08 23:11:14 +09:00
Takeshi KOMIYA
342de4f0fd
Merge branch '1.8'
2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
79de756423
Merge pull request #5342 from tk0miya/drop_py2_support
...
Update requirements and dependencies for Sphinx-2.0
2018-09-05 22:55:07 +09:00
Takeshi KOMIYA
abcb5bd5ec
The default setting for master_doc is changed to 'index'
2018-09-04 01:14:16 +09:00
TAKEDA-Takashi
683cccac4d
docs: Fix wrong name of MecabSplitter
2018-09-03 16:18:24 +09:00
Takeshi KOMIYA
daac35cda7
doc: Add versionadded label (refs: #5029 )
2018-09-03 10:46:38 +09:00
Timotheus Kampik
1a801524c6
Merge branch 'master' into 1618-make-search-results-reader-friendly
2018-08-29 19:01:13 +02:00
Takeshi KOMIYA
deca8047ae
LaTeX builder now depends on TeX Live 2015 or above
2018-08-30 01:03:57 +09:00
Timotheus Kampik
26bd565dee
Merge branch 'master' into 1618-make-search-results-reader-friendly
2018-08-27 21:34:43 +02:00
Takeshi KOMIYA
8c4de32c7d
Fix #4182 : autodoc: Support :confval:suppress_warnings
2018-08-26 23:29:00 +09:00
Takeshi KOMIYA
472001eeb7
Fix typo
2018-08-22 11:08:33 +09:00
Takeshi KOMIYA
e3f383ad7c
Merge pull request #5315 from tk0miya/add_autodoc_default_options
...
Add autodoc_default_options
2018-08-20 00:26:08 +09:00
Takeshi KOMIYA
17874a1a4b
Merge pull request #5297 from AWhetter/viewcode_follow_imported_event
...
Plugins can resolve imported members for viewcode
2018-08-19 23:45:09 +09:00
Takeshi KOMIYA
3d9e2cf831
Add autodoc_default_options
2018-08-18 18:22:16 +09:00
Jakob Lykke Andersen
1c035d7203
C++, add support for overload-specific references.
...
The "any" and "func" roles now accepts full function declarations.
Fixes #1552
2018-08-18 08:27:23 +02:00
Lewis Haley
f196a92055
autodoc: add 'exclude-members' to user global options
...
As the previous commit explains, it is now possible to specify arguments
to the global options in config files. This means that we can now include
the `exclude-members` option in this global configuration.
Previously, there was no point including this option because it makes no
sense without arguments. Including this option means users have the
flexibility of explicitly including which special methods they want using
(e.g.):
:special-members: __init__, __iter__
or explicitly excluding which special-members (or other members) they want
using (e.g.):
:exclude-members: __weakref__, __hash__
2018-08-17 16:02:11 +01:00
Lewis Haley
6e1e35c98a
autodoc: allow specifying values to global arguments
...
Previously, users could specify a *list* of flags in their config files.
The flags were directive names that would otherwise be present in the
.rst files. However, as a list, it was not possible to specify values
to those flags, which *is* possible in .rst files.
For example, in .rst you could say
:special-members: __init__, __iter__
And this would cause autodoc to generate documents for these methods that
it would otherwise ignore.
This commit changes the config option to instead accept a dictionary.
This is a dictionary whose keys can contain the same flag-names as before,
but whose values can contain the arguments as seen in .rst files.
The old list is still supported, for backwards compatibility, but the data
is transformed into a dictionary when the user's config is loaded.
2018-08-17 15:51:00 +01:00
Takeshi KOMIYA
28131df93e
Merge pull request #5307 from akaihola/5273_doctest_conditional_skip
...
Feature: skip doctests conditionally
2018-08-17 00:33:29 +09:00
Antti Kaihola
43d5810083
Ref #5273 : doctest: add documentation for the :skipif: option
2018-08-16 14:01:57 +03:00
Ashley Whetter
97164faec3
Plugins can resolve imported members for viewcode
2018-08-13 17:07:50 -07:00
Takeshi KOMIYA
f670a33f5b
Fix #5246 : Add :confval:singlehtml_sidebars to configure sidebars for singlehtml
2018-08-13 11:04:45 +09:00
Jakob Lykke Andersen
4397606d03
C++, fix direct lookup problem
...
Also clarify documentation regarding cross-references involving templates.
See also sphinx-doc/sphinx#2057
2018-08-11 11:04:56 +02:00
Takeshi KOMIYA
206395121d
Merge pull request #5250 from tk0miya/refactor_math4
...
Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`)
2018-08-04 21:03:49 +09:00
Takeshi KOMIYA
68630e68b9
Merge branch '1.7'
2018-08-04 20:34:42 +09:00
Takeshi KOMIYA
ec7ee91dd3
Merge pull request #5230 from tk0miya/726_mathjax_config
...
#726 , #969 : Add mathjax_config
2018-08-04 19:21:01 +09:00
Takeshi KOMIYA
8e56f86383
Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq)
2018-08-02 01:52:40 +09:00
Jean-François B
5edcb2850c
Merge pull request #5239 from jfbu/latex_revert_5181_RTDbug_workaround
...
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
2018-07-31 19:04:21 +02:00
jfbu
d07103fde2
Fix typo in updated docs
2018-07-31 17:11:59 +02:00
jfbu
b8f43e56ae
Update latex docs
2018-07-31 16:54:25 +02:00
jfbu
f0067f4a04
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
...
This reverts commit 9b2aac68ea
2018-07-31 10:46:48 +02:00
jfbu
9a0097bef2
Update LaTeX xindy docs
2018-07-30 19:52:12 +02:00
Takeshi KOMIYA
da7a06b323
WIP: #726 , #969 : Add mathjax_config
2018-07-29 22:36:53 +09:00
Timotheus Kampik
d14e950881
#5216 update Markdown config doc to API changes
2018-07-28 18:02:32 +02: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
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
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
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
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
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
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
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
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
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
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
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
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
Takeshi KOMIYA
0ea06e40ca
Merge branch 'master' into 789_escape_braces_on_samp_role
2018-05-03 01:32:35 +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
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
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
622119a9d4
Fix #789 : `:samp:` role supports to escape curly braces with backslash
2018-04-28 12:56:01 +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
Nicholas Devenish
5685512e6a
Add missing literalinclude options documentation
...
The start-at and end-at options, added in 560b572#625
weren't previously documented. This fixes that.
2018-04-11 18:10:37 +01:00
jfbu
525f3bd104
Typo from #4801
2018-04-01 11:39:58 +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
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
Tim Graham
725d20b0f9
Add section labels for intersphinx
2018-03-29 13:23:39 -04: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
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
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
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
jfbu
bde42595c6
Update installation docs
2018-03-17 22:56:53 +01: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
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
