IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-11-05 05:37:04 -06:00
Code Issues Packages Projects Releases Wiki Activity
13,886 Commits 4 Branches 238 Tags
eb273fdc08840945b9c2419f20fb2e0220b0a004
Commit Graph
251 Commits
Author SHA1 Message Date
Takeshi KOMIYA 74a5f350a1 Add new event: autodoc-before-process-signature 2020-01-13 13:16:59 +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 2f36d792f3 Update CHANGES for PR #5230 2020-01-01 12:59:20 +09:00
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
Damien Ayers 1a54a7229c Fix documentation typo 
(cherry picked from commit 937c684960)
 2019-12-13 23:27:04 +01:00
jfbu 2199a127e8 Typo (refs #6491) 2019-12-09 22:57:45 +01: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 7292ab7eef Merge branch '2.2.2' into 2.0 2019-12-03 01:19:02 +09:00
Takeshi KOMIYA 82a6048f12 Fix typo 2019-11-28 23:31:08 +09: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
Takeshi KOMIYA c6f0eb215a Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental) 2019-11-17 17:37:48 +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
Takeshi KOMIYA 32763520a3 Close #1331: Change default User-Agent header 2019-10-27 02:05:33 +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
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 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 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
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
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