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
15,515 Commits 2 Branches 219 Tags
a7bbedfbb71066614f5fc01da17caecd78da45c3
Commit Graph

405 Commits

Author SHA1 Message Date
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