Commit Graph

2660 Commits

Author SHA1 Message Date
Takeshi KOMIYA
93e519320b Merge pull request #7227 from tk0miya/7217_docker
Add a installation procedure for docker
2020-02-29 16:35:15 +09:00
Takeshi KOMIYA
e6f8ed063c doc: Update installation 2020-02-29 16:22:55 +09:00
Takeshi KOMIYA
61b8edcb49 doc: Move docker section above "install from source" 2020-02-29 16:16:56 +09:00
Tetsuo Koyama
89490287e7 🆕 docker-sphinx
Co-authored-by: tk0miya <i.tkomiya@gmail.com>
2020-02-25 12:47:14 +09:00
Tetsuo Koyama
e20430aee1 🆕 docker-sphinx 2020-02-24 16:04:53 +09:00
Tetsuo Koyama
e3fa132f2b ⬆️ doc/usage/installation.rst 2020-02-24 16:00:47 +09:00
Tetsuo Koyama
14d8cf636a 🆕 docker-sphinx 2020-02-24 15:41:27 +09:00
Takeshi KOMIYA
34255f6014 doc: Recommend to use py38-sphinx instead of py36-sphinx 2020-02-24 12:43:51 +09:00
Takeshi KOMIYA
448937eb4d doc: Remove mention about py2 2020-02-24 12:43:00 +09:00
Takeshi KOMIYA
bfce1a71f6 Merge pull request #7087 from geographika/named-index-links
Add name option for the index directive
2020-02-23 12:27:57 +09:00
sethg
b20d74f8a0 Review updates 2020-02-22 13:31:18 +01:00
Takeshi KOMIYA
754d04f80d Merge branch '2.4.x' into 3.x 2020-02-22 19:22:31 +09:00
Takeshi KOMIYA
9db38aadfd Fix #3106: domain: Register hyperlink target for index page automatically 2020-02-22 18:20:12 +09:00
Takeshi KOMIYA
bc14e8fd37 Merge branch '3.x' of github.com:sphinx-doc/sphinx into 3.x 2020-02-22 17:53:47 +09:00
Takeshi KOMIYA
b162273962 Merge pull request #7064 from tk0miya/7025_nosearch
Close #7025: html search: full text search can be disabled via metadata
2020-02-22 17:53:01 +09:00
Takeshi KOMIYA
2b70875f6a Merge branch 'drop_desc_signature_first' into 3.x 2020-02-22 17:39:56 +09:00
Takeshi KOMIYA
8987f3c031 Merge pull request #7062 from tk0miya/7032_no-scaled_link
Close #7032: html_scaled_image_link is disabled for individual image
2020-02-22 17:38:04 +09:00
Takeshi KOMIYA
30b0361f9c Close #7025: html search: full text search can be disabled via metadata 2020-02-22 17:34:44 +09:00
Takeshi KOMIYA
5648b2eb88 Deprecate DescDirective 2020-02-22 12:15:20 +09:00
Vince Salvino
9fdc18d8de Adding documentation 2020-02-21 18:41:46 -05:00
Takeshi KOMIYA
a033d53c24 Close #7032: html_scaled_image_link is disabled for individual image 2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
4fc80e2816 Merge pull request #7168 from tk0miya/6346_update_doc
doc: Update usage/quickstart.rst to adjust latest quickstart
2020-02-18 00:58:47 +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
Takeshi KOMIYA
c97218cc97 doc: Fix file inclusion in recipe tutorial has been broken 2020-02-17 01:20:59 +09:00
Takeshi KOMIYA
379f52badf Merge pull request #7154 from tk0miya/deprecate_Parser.app
Deprecate sphinx.parsers.Parser.app
2020-02-16 22:19:22 +09:00
Takeshi KOMIYA
954db2bd27 Merge branch '2.0' 2020-02-16 21:42:20 +09:00
Takeshi KOMIYA
9409db0771 Deprecate sphinx.parsers.Parser.app 2020-02-15 00:39:34 +09:00
Takeshi KOMIYA
baf4c7df23 Deprecate sphinx.util.inspect.getargspec() 2020-02-14 12:08:52 +09:00
Simon Willison
9b38e87468 Update copyright for 2020 2020-02-13 14:59:13 -08: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
6e0119526a Merge branch '2.0' 2020-02-09 16:21:32 +09:00
Takeshi KOMIYA
f751ab832e Merge pull request #7113 from tk0miya/6327_apidoc_init.so
Fix #6327: apidoc: Support a python package consisted of __init__.so file
2020-02-09 10:50:45 +09:00
Takeshi KOMIYA
df3c0448dd Deprecate desc_signature['first'] 2020-02-09 00:58:42 +09: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
dee8b9eddb Fix #6327: apidoc: Support a python package consisted of __init__.so file 2020-02-08 18:11:48 +09:00
Takeshi KOMIYA
9d301e5b81 refactor: apidoc.shall_skip() 2020-02-08 17:59:29 +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
7c90a05144 Merge branch '2.0' into 6772_apidoc_quiet_mode 2020-02-02 23:59:52 +09: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
7d6374d983 testing: Add Path.read_text() and Path.read_bytes()
To migrate pathlib.Path in future, compatibile methods are needed
for our Path class.
2020-02-01 11:45:47 +09:00
Takeshi KOMIYA
41032572a5 Merge branch '2.0' 2020-02-01 11:17:03 +09:00
Takeshi KOMIYA
aced2be1fb apidoc: Add `-q` option for quiet mode (refs: #6772) 2020-02-01 00:30:09 +09:00
Takeshi KOMIYA
b73cc5652a Update deprecation list 2020-01-31 01:59:24 +09:00
Takeshi KOMIYA
52afc79e1f Merge branch '2.0' into refactor_latex 2020-01-31 01:18:57 +09:00