IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-31 17:17:43 -05:00
Code Issues Packages Projects Releases Wiki Activity
22,461 Commits 4 Branches 238 Tags
master
Commit Graph
233 Commits
Author SHA1 Message Date
Takeshi KOMIYA 73e99ab88b Update CHANGES and docs for PR #7064 2020-03-05 20:40:35 +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 30b0361f9c Close #7025: html search: full text search can be disabled via metadata 2020-02-22 17:34:44 +09:00
sethg 28ad370343 Add option to docs 2020-02-16 21:37:41 +01:00
Takeshi KOMIYA 2e87ee85a2 Merge branch '2.0' 2020-02-09 00:57:53 +09:00
Takeshi KOMIYA f6acd061f3 docs: Add a restriction note about tocdepth (refs: #6033) 2020-02-07 23:59:20 +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
Jakob Lykke Andersen 9fa23615ec Fixes from review 2020-01-25 17:02:59 +01:00
Jakob Lykke Andersen c084c3f124 Implement scoping for productionlist 
Fixes sphinx-doc/sphinx#3077
 2020-01-22 22:32:30 +01: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 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
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
Joe 1fd7176f89 Fix link to pygments lexer 2019-11-16 18:11:14 -08: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
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 d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09:00
Takeshi KOMIYA 9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA 3105feec80 doc: Update with rst:directive:option directive 2019-05-20 00:26:28 +09:00
Takeshi KOMIYA 358e582490 Add :abstractmethod: option to py:method directive (refs: #6138) 2019-05-15 00:00:51 +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 e0abb10792 Fix #4777: Add :async: option to py:function and py:method directives 2019-04-23 01:40:37 +09:00
Takeshi KOMIYA 331594e2ca Add :classmethod: and :staticmethod: options to py:method directive 2019-04-13 23:14:59 +09: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
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 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
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
Jakob Lykke Andersen d6b7aad138 C++, alias directive 
See sphinx-doc/sphinx#4981
 2019-01-12 12:57:45 +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