IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
13,822 Commits 2 Branches 219 Tags 163 MiB
18e25d680d
Commit Graph

63 Commits

Author SHA1 Message Date
Takeshi KOMIYA
18e25d680d Close #6966: graphviz: Support `:class:` option 2019-12-27 22:38:10 +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
29687a29f1 Close #6446: Add sphinx.ext.durations to inspect durations of build 2019-12-16 00:47:23 +09:00
Takeshi KOMIYA
82a6048f12 Fix typo 2019-11-28 23:31:08 +09:00
Takeshi KOMIYA
82b2b1752a doc: URL of numpydoc has changed 2019-11-27 00:12:32 +09:00
Takeshi KOMIYA
66c3dd3adb Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file 2019-11-16 18:19:31 +09:00
jfbu
4ae5414ee5 Update our docs for imgmath_latex (refs: #6610) 2019-08-03 12:00:24 +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
Takeshi KOMIYA
828beb12e0 doc: Update document for :annotation: option (refs: #6495) 2019-06-29 18:43:30 +09:00
Takeshi KOMIYA
ce2f9c2b94 Close #5124: graphviz: :graphviz_dot: option is renamed to :layout: 2019-06-02 21:33:34 +09:00
Takeshi KOMIYA
1303ea7cdf docs: Use directive:option in extensions/graphviz 2019-06-02 18:18:55 +09:00
Takeshi KOMIYA
91fceb4b5f Merge branch '2.0.2' into 2.0 2019-06-02 00:58:46 +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
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
0ea380eddd Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature 2019-05-26 00:35:24 +09:00
Adrián Chaves
e84ba7f78a Support coverage_ignore_pyobjects in the coverage builder 2019-05-15 12:23:05 +02: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
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
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
Takeshi KOMIYA
ceef713e79 docs: Remove a term "new" from config values 2019-02-27 01:18:57 +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
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
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
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
5b2befe97d doc: Fix description for viewcode_follow_imported_members 2018-12-23 22:13:33 +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
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
Jon Dufresne
dd383ec472 Prefer https:// links where available 2018-09-23 11:50:42 -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
342de4f0fd Merge branch '1.8' 2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
daac35cda7 doc: Add versionadded label (refs: #5029) 2018-09-03 10:46:38 +09:00