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
20,127 Commits 2 Branches 219 Tags
cc78e2a8d81624769c6120ac5798cb7de153a0f6
Commit Graph

137 Commits

Author SHA1 Message Date
Adam Turner
8942a1dddf Test with Docutils 0.20 2023-05-09 19:24:18 +01:00
James Addison
c9d0933e5d linkcheck: Use context managers for HTTP requests (#11318) 
This closes HTTP responses when no content reads are required, as
when requests are made in streaming mode, ``requests`` doesn't know
whether the caller may intend to later read content from a streamed
HTTP response object and holds the socket open.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-05-09 17:09:35 +01:00
Adam Turner
2b1c106bbf Update documentation workflow 
- Add 'workflow_dispatch' target
- Force output to use colour
- Print traceback on error
- Use parallel building
 2023-05-09 16:51:52 +01:00
Adam Turner
ba7408209e Change concurrency groups for GitHub workflows 
This means that 'push' triggered workflows are not cancelled.
 2023-04-29 22:44:55 +01:00
James Addison
0fb6716f3f Continuous integration: resolve docutils installation step build failures (#11331) 
* continuous integration: add comment explaining PYTHONWARNINGS env var to main unit test workflow

* continuous integration: unit test workflow: report-but-do-not-fail
  when warnings about pkg_resources deprecation are encountered during
  docutils dependency installation

* continuous integration: unit test workflow: instead of reducing the
  severity of all DeprecationWarnings during docutils (non-dev)
  installation, apply two message filters - one each for the warnings
  encountered so far

* continuous integration: unit test workflow: add 'module' and 'line'
  fields for warning filters

Ref:
https://docs.python.org/3/library/warnings.html#describing-warning-filters


---------

Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
 2023-04-16 15:05:09 +02:00
Adam Turner
7ecf037280 Enable 'nit-picky mode' for Sphinx's documentation 
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
 2023-04-06 23:11:39 +01:00
Adam Turner
52a099b7ec Resolve lint errors from Ruff 0.0.261 2023-04-05 14:19:43 +01:00
Adam Turner
f019b89c05 Run Ruff linting with a known-to-work version 
This means that CI tests will only fail if the 'known good' version
fails. If the latest version of Ruff fails, perhaps due to new
checks, CI will not fail overall, but the failures from the latest
version will be reported.
 2023-03-31 17:52:29 +01:00
Jean-François B
3e6d56adc0 Pin to ruff==0.0.259 (provisory) 
This is because I would like CI to succeed for a while in order to merge
some LaTeX patch.
 2023-03-31 17:18:29 +02:00
Jean-François B
321f886097 Provis. ignore onerror depr. warn when install. DocUtils with 3.12-dev 2023-03-26 23:52:55 +02:00
Adam Turner
a846f958bc Properly quote a string value in `transifex.yml` 2023-03-15 15:47:25 +00:00
Adam Turner
57545d0789 Update translations workflow for new `tx` client 2023-03-15 15:45:36 +00:00
Adam Turner
cfd43d4dbe Simplify coverage workflow reporting 
``PYTHONDEVMODE`` and ``PYTHONWARNDEFAULTENCODING`` are used in the
main tests, remove from the coverage workflow.
 2023-02-15 05:24:51 +00:00
Adam Turner
9b104523e9 Ignore `coverage.py` warnings 2023-02-15 05:14:44 +00:00
Adam Turner
c17300aa7a Treat Python warnings as errors during testing 2023-02-15 04:34:10 +00:00
Adam Turner
607908924c Always cancel in-progress workflows on new commits 
The current ``github.head_ref || github.run_id`` syntax only cancels
in-progress GitHub Actions runs triggered by pull requests, as
``head_ref`` is only defined for pull requests, and ``run_id`` is
always unique. This changes to using ``ref``, which is the name of
the branch or tag linked to the commit, meaning that in-progress jobs
will be cancelled on pushes to a branch.
 2023-02-15 03:35:49 +00:00
Adam Turner
ff852bc7c3 Update GitHub Actions workflows 2023-02-15 03:10:50 +00:00
Hugo van Kemenade
59cdb1ffe1 Ensure Ruff creates logs in colour for GitHub Actions (#11190) 2023-02-11 13:21:27 +00:00
Adam Turner
f8e8584ea5 Update GitHub bug report template 2023-01-01 19:44:35 +00:00
Adam Turner
03c6244949 Re-enable CI testing with Python 3.12 alphas 
This partially reverts commit 7418d2ccc4
 2022-12-30 18:11:52 +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
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
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
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
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
Adam Turner
e70a0fac6d Merge branch '5.x' 
# Conflicts:
#	.github/workflows/main.yml
#	CHANGES
#	sphinx/__init__.py
#	sphinx/domains/c.py
 2022-10-16 11:24:18 +01:00
Adam Turner
0fd45397c1 Simplify bug report template 2022-10-14 16:05:54 +01:00
Adam Turner
b58eb61c9f Update all GitHub actions workflows to Ubuntu latest 2022-10-14 16:04:04 +01:00
Adam Turner
cef1a030cd Update image for LaTeX job (#10916) 2022-10-12 23:01:55 +01:00
Adam Turner
63dea6172a Merge branch '5.x' 
# Conflicts:
#	sphinx/locale/__init__.py
 2022-09-30 16:15:24 +01:00
Julien Schueller
7514e5c6d4 CI: Move LaTeX job to GitHub Actions (#10884) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-09-30 00:03:51 +01:00
Adam Turner
bb62d2a2ee Increase minimum Docutils to 0.18 2022-09-27 18:31:47 +01:00
Adam Turner
080517ce55 Increase minimum Docutils to 0.17 2022-09-27 18:31:47 +01:00
Adam Turner
4660b62de0 Drop Python 3.7 2022-09-27 18:31:47 +01:00
Adam Turner
7649eb1505 Clean up after dropping Python 3.6 2022-09-27 18:31:47 +01:00
Adam Turner
56aa3412ef Merge branch '5.x' 
# Conflicts:
#	setup.py
#	sphinx/__init__.py
 2022-09-23 17:27:00 +01:00
Adam Turner
b347657809 Use declarative metadata 
- Move to pyproject.toml metadata
- Update references to `setup.py`
- Use pypa/build
- Update workflows and tooling
 2022-09-13 10:31:27 +01:00
Adam Turner
14c9b40f15 Merge branch '5.x' 
# Conflicts:
#	setup.py
#	sphinx/application.py
#	sphinx/environment/__init__.py
#	sphinx/ext/autodoc/directive.py
#	tests/test_build_html.py
 2022-09-09 09:58:24 +01:00
Alex
a9b4b19be5 Restrict permissions in GitHub workflows (#10790) 2022-08-28 15:59:06 +01:00
Adam Turner
1e3ade55fe Merge branch '5.x' 2022-07-10 23:05:23 +01:00
Adam Turner
1f21e973d4 Use released Docutils 0.19 on CI 2022-07-06 19:18:10 +01:00
Takeshi KOMIYA
3d175d9a24 Merge branch '5.x' 2022-07-03 22:40:34 +09:00
Takeshi KOMIYA
5c22bd86ef CI: Update lock-threads to v3 2022-07-03 14:05:46 +09:00
Takeshi KOMIYA
6de301eaff Merge pull request #10630 from sphinx-doc/dependabot/github_actions/peter-evans/create-pull-request-4 
Bump peter-evans/create-pull-request from 3 to 4
 2022-07-03 13:44:04 +09:00