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
19,978 Commits 2 Branches 219 Tags 163 MiB
69066d0bb7
Commit Graph

19978 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Adam Turner
2c97bfaa19 Remove redundant import aliases with isort 2022-12-29 23:53:48 +00:00
Adam Turner
5b9736773b Enable Ruff's pyupgrade checks 2022-12-29 23:53:48 +00:00
Adam Turner
3bcf11c30c Enable Ruff's flake8-debugger checks 2022-12-29 23:53:48 +00:00
Adam Turner
7fb45a9058 Enable Ruff's flake8-bandit checks 2022-12-29 23:53:48 +00:00
Adam Turner
b5357774a7 Enable Ruff's pylint checks 
Also fix two PLW0602 warnings (``global`` without assignment) and
five PLW0120 warnings (else clause on loop without break).
 2022-12-29 23:53:48 +00:00
Adam Turner
b89c33fc0a Enable Ruff's pygrep-hooks checks 2022-12-29 23:53:48 +00:00
danieleades
6a132eba5a
Tighten mypy 'strict optional' whitelist (#11038) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-12-29 19:09:17 +00:00
James Addison
bb37309a6d
Remove support for pluralisation during `gettext` resource translation (#10979) 
Code related to ``ngettext`` (support for n-ary / plural forms of
translated text) doesn't appear to be used, so this commit cleans up
the code by removing the ``ngettext`` reference.

Detail
------

- ``ngettext`` allows an application to provide a dynamic number
  (often a count of items, like '5' in ``the linter produced 5
  warnings``) to the translation query so that a plurality-relevant
  message can be retrieved from the catalogue.
- ``sphinx`` has previously used this within its own codebase, but no
  longer does -- ``babel`` command-line extraction [1] is used to
  retrieve translatable resources from the codebase, and extraction
  of plural-form keywords is not configured (nor easy to enable, as
  far as I could tell).
- As a result it seems like it may make sense to remove the code.

[1]: https://babel.pocoo.org/en/latest/cmdline.html#extract
 2022-12-29 19:08:47 +00:00
Adam Turner
5a46d8d7e1 Check NoQA comments with Ruff 
This uses the special 'RUF100' code to check NoQA comments.
https://github.com/charliermarsh/ruff#automating-noqa-directives
 2022-12-29 17:05:05 +00:00
Adam Turner
8634fbce60 Adopt the Ruff code linting tool 
https://github.com/charliermarsh/ruff
 2022-12-29 17:00:27 +00:00
Adam Turner
f852661243 Allow line breaks before binary operators 2022-12-29 15:55:52 +00:00
Adam Turner
6016b4d634 Break lists in `.flake8` to one item per line 2022-12-29 15:53:37 +00:00
Adam Turner
6b09d193a6 Rename `setup.cfg to .flake8` 2022-12-29 15:44:04 +00:00
Adam Turner
30a9067a34 Bump version 2022-12-29 15:14:50 +00:00
Adam Turner
5b56a231af Bump to 6.0.0 final 2022-12-29 14:59:17 +00:00
Adam Turner
f1d1e9c997 Update coverage workflow for Tox 4 2022-12-29 14:50:24 +00:00
Adam Turner
66a738c2bf Update coverage workflow for new configuration location 2022-12-29 14:28:58 +00:00
James Addison
041e5f8268
Add test coverage for 'today_fmt' reference substitution (#10980) 2022-12-29 14:19:43 +00:00
Antony Lee
da25145d08
Remove unnecessary conditional import in `sphinx.ext.napoleon` (#11043) 
The conditional import could have been useful for the external
sphinxcontrib.napoleon (to keep backcompat with older versions of
sphinx), but seems just confusing for a builtin extension.
 2022-12-29 14:11:11 +00:00
Sergey B Kirpichev
45a0ea9fc9
Migrate coveragepy config into pyproject.toml (#11025) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-12-29 14:09:56 +00:00
Tim Hoffmann
3ec54f1183
Create a `pydata_sphinx_theme` section in usage examples (#11046) 2022-12-29 13:59:34 +00:00
mikemckiernan
32bce8fb7c
Copy edit the tutorial (#11049) 
- Correct two typos.
- Include the ingredient index in the "for example"
  statement. It's tedious, but the audience is reading
  to learn.
 2022-12-29 13:58:32 +00:00
Martin Liška
9844162473
Fix example using `add_config_value` (#10937) 
``add_config_value()`` has mandatory 3 arguments.
 2022-12-20 13:15:00 +00:00
Martin Liška
bf4a626826
RTD builder: add graphviz depedendency (#11040) 2022-12-20 12:30:59 +00:00
Hugo van Kemenade
644043c317 Remove redundant instructions from PR template 2022-12-16 16:56:43 +01:00
Daniel Eades
841c0cecb3 check for blanket noqas in CI 2022-12-16 16:50:24 +01:00
Daniel Eades
1abb24e309 remove blanket 'noqas' 2022-12-16 16:50:24 +01:00
Hugo van Kemenade
dc29bf9abe
Docs: Update devguide link (#11017) 
Update devguide link
 2022-12-16 16:42:11 +01:00
amyreyespdx
782c663c0c
doc: Fix typos in contributing.rst (#10961) 2022-12-16 16:38:53 +01:00
Jean-François B
7418d2ccc4
Deactivate (provisorily) Python12-dev testing (#11035) 
* fix flake8 warnings

* Deactivate (provisorily) testing with 3.12-dev

(refs:
https://github.com/sphinx-doc/sphinx/pull/10995#issuecomment-1330310586
)

* Escape # in tox.ini for tox 4 compatibility ('du-latest' tests)

Co-authored-by: Daniel Eades <danieleades@hotmail.com>
 2022-12-16 12:41:54 +01:00
Jérémie Tarot
d8977d3e57
docs: intl.rst: small fixes while translating (#11020) 2022-12-07 13:53:44 +01:00
Jean-François B
b1ca6b3e12
Fix #10984 [DOC] document latex_additional_files behavior with .tex (#10993) 2022-11-30 18:52:48 +01:00
Adam Turner
cd3f2e4350 Update typing ignores for mypy 0.990 2022-11-13 20:36:24 +00:00
Adam Turner
a6032e852a Recommend `sphinxcontrib.jquery` in CHANGES 2022-11-06 23:48:28 +00:00
Jean-François B
2f60b44999 Avoid a cramped LaTeX table column in our own document 
This is for the table of the Websupport.get_data() auto-documentation.

Somethink similar perhaps \setlength{\tymin}{1.5cm} at least could be a
global default; the only reason we have not changed it yet is that
perhaps some tables in user projects use really short contents such as
letter.

(what we would want to avoid is narrow columns allowed by hyphenation of
single words; maybe some thinking needed here as \sphinxAtStartPar
renders this hyphenation possible but perhaps even upstream LaTeX has
now made hyphenation of single words work in table cells).
 2022-10-30 17:09:30 +01:00
Adam Turner
4bf9f65680
Use Sphinx 5.3+ in bug report template 2022-10-28 22:12:02 +01:00
Adam Turner
33d65fbdaf Merge Docutils master tests into the main workflow 2022-10-27 09:53:56 +01:00
Adam Turner
69035f5315 Automatically cancel CI runs when new commits are pushed 2022-10-27 09:50:52 +01:00
Adam Turner
995e2615a7 Test on Python 3.12 prereleases 2022-10-27 09:48:14 +01:00
Dmitry Shachnev
93215f0a64
doc: Actualize information about generating snowball JS files (#10931) 2022-10-24 01:07:05 +01:00
Xuan Wang
b90bf8d193
Bump required requests version to 2.25.0 (#10929) 2022-10-22 01:33:32 +01:00
Adam Turner
cc314f13e8 Bump version 2022-10-17 22:40:57 +01:00
Adam Turner
4c2a82305c Bump to 6.0.0 beta2 2022-10-17 22:40:11 +01:00
Adam Turner
920828fe35 Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
Adam Turner
b277abcb49 Use `ast.parse` from the standard library 2022-10-17 15:22:06 +01:00
Adam Turner
eb6e137097 Merge `_py37 functions in util.typing` 
- restify and _restify_py37
- stringify and _stringify_py37
 2022-10-17 15:22:06 +01:00
Adam Turner
dd7f65c98f Prefer `raise SystemExit to sys.exit` 2022-10-17 15:22:06 +01:00
Martin Liška
2a70006e59
Link to static JS libraries from Sphinx 5.3 (#10926) 
This is the last Sphinx minor version to include ``jquery.js`` and ``underscore.js``.
 2022-10-17 13:17:30 +01:00
Jean-François B
49c48f5aee
LaTeX: switch to some nicer defaults for tables and code-blocks (#10924) 2022-10-17 11:19:25 +02:00
Jean-François B
78cf903bc1
Update documentation of latex builder (#10925) 2022-10-17 10:54:31 +02:00