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
18,839 Commits 2 Branches 219 Tags
b20e04968e73234da9fff7d19b12dfbeebebe944
Commit Graph

3417 Commits

Author SHA1 Message Date
Takeshi KOMIYA
b20e04968e Merge pull request #10107 from Jean-Abou-Samra/intl-warnings 
Implement #noqa for i18n
 2022-03-27 23:00:57 +09:00
Takeshi KOMIYA
f559389d14 Merge pull request #10301 from tk0miya/refactor_parserapi_doc 
doc: Update docs for sphinx.parsers.Parser
 2022-03-27 19:45:41 +09:00
Takeshi KOMIYA
e530c00b82 doc: Update docs for sphinx.parsers.Parser 2022-03-27 19:27:53 +09:00
Takeshi KOMIYA
7ae8c1ee42 Merge pull request #10300 from tk0miya/doc_URL_changed 
doc: URL of requests has changed now
 2022-03-27 16:21:03 +09:00
Takeshi KOMIYA
7ffc606e0c doc: URL of requests has changed now 2022-03-27 16:13:15 +09:00
Takeshi KOMIYA
c6230dc4db extlinks: Disable hardcoded links detector by default (refs: #10126) 
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
 2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
fbdfade068 doc: Use :pep: role to refer PEP documents 2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10 Update PEP links in docs 2022-03-24 12:34:05 +02:00
Takeshi KOMIYA
4e9c1017ed Merge pull request #10260 from hugovk/colour-env-vars 
Enable FORCE_COLOR and NO_COLOR for terminal colouring
 2022-03-17 00:38:57 +09:00
Hugo van Kemenade
cdf9456699 Document NO_COLOR and FORCE_COLOR environment variables 2022-03-13 17:43:22 +02:00
Takeshi KOMIYA
7b55447b7e Update versionadded to 4.5 2022-03-06 18:47:17 +09:00
Takeshi KOMIYA
fa63db8dc6 Update versionadded to 4.5 2022-03-06 18:47:11 +09:00
Takeshi KOMIYA
08f5d97a82 Fix #10223: doc: Add descriptions of :module: option for python directives 2022-03-06 16:10:40 +09:00
Jean Abou Samra
94d78d8747 Close #3985: Implement #noqa for i18n 
When cross-references in the original paragraph and the translated
paragraph do not match, a warning is emitted.  It is useful, because
it allows to catch mistakes, but it can also be an annoyance since
sometimes it is expected that the cross-references will not match.
For example, a reference that is repeated in the original text may
need to be factored out for good style in the target language.
Another example: if the translator needs to translate a universally
understood term in the source language into a term that not everyone
knows is the translation of this original term, adding a reference to
the glossary can be warranted.  This allows the translated message to
start with '#noqa' in order to disable the warning.
 2022-02-15 19:51:06 +01:00
Jean Abou Samra
dfcb5d2f4c Categorize warnings for inconsistent references in i18n 
This allows suppressing them using the suppress_warnings configuration
variable.
 2022-02-15 14:32:22 +01:00
Takeshi KOMIYA
8224f6f44a Fix #10181: napoleon_use_ivar adds unexpected prefix to vars 
Since 4.0, :ivar: items has not been rendered as hyperlinks.  So any
modules, classes and tilda are now harmful.  This removes the prefixing
filter for napoleon_use_ivar option.

refs: #5129 and #5977
 2022-02-12 00:50:56 +09:00
Daniel Townsend
bcb0a03f92 setup -> set up 2022-02-10 17:44:18 +00:00
Daniel Townsend
03c8ceb85f improve grammar in theming.rst 2022-02-08 13:05:18 +00:00
Takeshi KOMIYA
680417a10d Merge pull request #10150 from tk0miya/10146_autodoc_default_options_should_support_no-value 
Close #10146: autodoc: autodoc_default_options does not support `no-value` option
 2022-02-06 15:59:24 +09:00
Takeshi KOMIYA
7469096e0a Update doc/usage/extensions/autodoc.rst 2022-02-06 15:30:54 +09:00
Noah Sprent
25c4287da5 Remove commas when describing characters for section headings 2022-02-02 10:52:06 +01:00
Takeshi KOMIYA
b0b51cecc2 Close #10146: autodoc: autodoc_default_options does not support no-value option 2022-01-31 01:51:37 +09:00
Takeshi KOMIYA
799385f555 Merge pull request #9337 from marxin/new-shortcuts 
Implement new search shortcuts.
 2022-01-31 00:11:45 +09:00
Timo Cornelius Metzger
8f39f29725 Update autosummary.rst 2022-01-27 20:22:45 -08:00
Martin Liska
8cf3179ad2 Implement new shortcuts: 
- "/" for Focus search bar
- "ESC" - clear highlighted text

Fixes #691.

Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-01-22 16:16:35 +01:00
Hinrich Mahler
84a6270685 Mention nitpick_ignore(_regex) in docs of warn-missing-reference 2022-01-18 22:01:52 +01:00
Takeshi KOMIYA
72bb5c998f Close #9456: html search: Add a config variable; html_show_search_summary 
refs: #9494
 2022-01-17 01:44:42 +09:00
Jakob Lykke Andersen
3bf8bcd6e1 intersphinx role, update docs 2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen
540d76035c intersphinx role, documentation 2022-01-16 09:48:06 +01:00
Takeshi KOMIYA
d82d370739 Merge pull request #10078 from danieleades/refactor/unused-loop-control-variables 
address some unused loop control variables
 2022-01-16 02:46:32 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +09:00
danieleades
9c68cd12d7 Update recipe.py 2022-01-14 08:58:54 +00:00
Daniel Eades
6697ed62ed address some unused loop control variables (B007) 2022-01-12 20:19:18 +00:00
Jean Abou Samra
0269bec1ed In translated docs, sort glossaries by translated terms 
This is done by moving the sorting from the glossary directive to a
transform operating after the i18n transform.

Closes #9827
 2022-01-12 16:47:40 +01:00
Takeshi KOMIYA
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Takeshi KOMIYA
a87153c018 autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format (refs: #9931) 2021-12-24 10:14:19 +09:00
Takeshi KOMIYA
733ac6ed5f doc: Update explanation of autodoc_unqualified_typehints (ref: #9931) 2021-12-18 15:26:42 +09:00
Takeshi KOMIYA
f107ff4761 Merge pull request #9963 from tk0miya/refactor_doc 
doc: Use "console" for the highlight language of console output
 2021-12-16 01:37:39 +09:00
Takeshi KOMIYA
b1df3fa94b Merge pull request #9287 from ssbarnea/fix/irc 
Document new irc channel location
 2021-12-16 01:33:53 +09:00
Takeshi KOMIYA
dd27e35e4c doc: Use "console" for the highlight language of console output 
Using "console" language is better for the console example (including
command-line prompt)
 2021-12-13 14:20:37 +09:00
Takeshi KOMIYA
0b238d897c Fix #9108: docs: Use default pygments_theme to get accessiblity 
To increse accessiblity of our docs, this changes the pygments_theme of
sphinx-docs.org to "default".  It was updated to meet WCAG AA in
https://github.com/pygments/pygments/pull/1940.
 2021-12-11 11:34:51 +09:00
Takeshi KOMIYA
d3162d1ff2 Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehints 
Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
 2021-12-11 10:59:23 +09:00
Takeshi KOMIYA
8d071a8e8f Merge branch '4.x' into texinfo-add-texinfo_emit_document_references 2021-12-11 10:27:50 +09:00
Christian Roth
10023da895 linkcheck: Exclude links from matched documents 2021-12-08 10:01:45 +01:00
Jouke Witteveen
e200e7b7c1 doc: Improve autodoc extension example 
Enumerations can have aliases, which should be documented as well.
 2021-12-06 12:31:09 +01:00
Takeshi KOMIYA
86639b7be9 Merge pull request #9852 from astrojuanlu/new-tutorial-deploying 
New Sphinx tutorial, part IV
 2021-12-04 12:02:23 +09:00
Takeshi KOMIYA
c71ff1cd21 Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints 
If autodoc_unqualified_typehints feature enabled, autodoc suppresses the
leading module names of typehints of function signatures (ex.
`io.StringIO` -> `StringIO`)
 2021-12-03 18:05:49 +09:00
Jouke Witteveen
bc849e2170 doc: Fix autodoc extension example 
`directivetype` is set to mimic `ClassDocumenter`. Reflect that.

`isinstance` would work on the enum members, but that is not what we want here.
`issubclass` raises a TypeError when called on objects that are not classes.
 2021-12-02 16:50:09 +01:00
Takeshi KOMIYA
74d912133a Merge pull request #9800 from hoefling/extlinks/replacements-check 
Proposal: check if hardcoded URLs can be replaced with extlinks
 2021-11-29 09:36:55 +09:00