Commit Graph

41 Commits

Author SHA1 Message Date
Adam Turner
541bf7bc67
Drop support for Python 3.10 (#13000) 2024-10-17 20:59:41 +01:00
Jared Dillard
5a4859a2e4
Add docs about sphinx-autobuild (#13011)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-12 19:07:23 +01:00
Adam Turner
fadb6b10cb
Stop exiting early with `--fail-on-warnings; add --exception-on-warning` (#12743)
Co-authored-by: Jeremy Maitin-Shepard <jbms@google.com>
2024-08-13 17:12:42 +01:00
James Addison
e3238260f6
Migrate JavaScript tests from Karma to the Jasmine framework (#12754) 2024-08-10 00:18:27 +01:00
Adam Turner
3b14b56939 Move the `sphinx.testing` overview to the API section 2024-07-24 15:21:14 +01:00
Adam Turner
7b6d448517 Update the contributor's guide 2024-07-24 15:21:14 +01:00
Adam Turner
7abf85a7f3 Update the Python version support policy to reflect SPEC 0 2024-07-23 23:40:45 +01:00
Adam Turner
9e3f4521db
Drop support for Python 3.9 (#12633) 2024-07-22 15:05:15 +01:00
James Addison
568e26c797
[tests] JavaScript: refactor test fixtures (#12102)
This PR allows to serve JavaScript test fixtures using a fixture-based logic as for Python tests.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-06-13 13:07:46 +02:00
Hugo van Kemenade
c06f246124
sphinx.ext.extlinks: Add extlink-{name} CSS class to links (#12319) 2024-05-15 04:21:11 +02:00
Adam Turner
5d98553b63 Add Python 3.12 to the version support policy 2024-04-11 19:57:11 +01:00
Chris Sewell
b45fee696f
🔧 Sync make doclinter with CI check (#12156)
Unignore files in `make doclinter` command, fix the resulting issues, and use this command in the CI job
2024-03-21 13:12:06 +01:00
Chris Sewell
d908886c03
📚 add tip about running karma js tests on mac (#12140)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-03-20 21:55:34 +01:00
Adam Turner
655bd15749 Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
Adam Turner
c17300aa7a Treat Python warnings as errors during testing 2023-02-15 04:34:10 +00:00
Adam Turner
ff852bc7c3 Update GitHub Actions workflows 2023-02-15 03:10:50 +00:00
Adam Turner
670bcb743b
Documentation reshuffle (#11112) 2023-01-08 13:52:36 +00:00
amyreyespdx
782c663c0c
doc: Fix typos in contributing.rst (#10961) 2022-12-16 16:38:53 +01:00
Dmitry Shachnev
93215f0a64
doc: Actualize information about generating snowball JS files (#10931) 2022-10-24 01:07:05 +01:00
Adam Turner
0200a75fe1
Simplify development policy (#10921) 2022-10-16 16:51:22 +01:00
Adam Turner
7649eb1505 Clean up after dropping Python 3.6 2022-09-27 18:31:47 +01:00
Adam Turner
94024e6efa Merge branch '5.x'
# Conflicts:
#	sphinx/ext/autodoc/__init__.py
#	sphinx/writers/html5.py
2022-07-18 22:49:56 +01:00
Chris Holdgraf
eb0a6c574f
Update documentation structure and theming (#10677)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-07-18 22:48:28 +01:00
Takeshi KOMIYA
7e68154e49
Drop python 3.6 support (#10468) 2022-06-16 19:33:55 +01:00
Adam Turner
22f7a0124c Update documentation 2022-04-16 21:12:18 +01:00
Takeshi KOMIYA
5dc27f5948 Merge branch '4.x' 2021-12-17 02:09:33 +09:00
Juan Luis Cano Rodríguez
1b6693d055 Document Python version policy
See https://groups.google.com/g/sphinx-dev/c/oDJ0KOLAmGk/m/X6N_UxpABAAJ
2021-07-01 20:17:29 +02:00
Sorin Sbarnea
82d769c56e Document new irc channel location 2021-06-01 11:09:19 +01:00
igo95862
7554ad9593
doc: Upgraded babel.pocoo.org links to HTTPS 2021-05-16 16:37:51 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS
Also change any docutils.sourceforge.net link to io
top level domain.
2021-05-16 15:53:49 +03:00
Takeshi KOMIYA
c99412695d
Merge pull request #8292 from tk0miya/update_coding_style
docs: Update coding style
2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
cad02e62e6 Fix #8375: URL of transifex project page 2020-11-05 23:52:59 +09:00
Takeshi KOMIYA
8260d6b4fc docs: Update coding style
Remove a reference to Pocoo Styleguide because it is removed now:
https://github.com/pallets/flask/pull/3554
2020-10-05 22:16:59 +09:00
Yves Chevallier
e45f55d32f Add rubric in Getting help 2020-08-15 13:34:57 +02:00
Stephen Finucane
227bbf6559 docs: Expand organization document
Provide some guidance on how one can become a core developer and explain
the different types of contribution one can make.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:13:31 +01:00
Stephen Finucane
fa5fadc3f3 docs: Tweaks to code of conduct
- Replace unicode quotes with ascii, since Sphinx will automatically
  translate these for us
- Move the header to the root document
- Use an admonition instead of a header for the attribution section

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:10:24 +01:00
Stephen Finucane
6b480c97b2 docs: Rework contributing document, re-add CONTRIBUTING
Reorder this to flow a little better and re-add the CONTRIBUTING
document, which now simply points to the main documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:10:21 +01:00
Stephen Finucane
d3021f644f docs: Add contributing document
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 12:08:34 +01:00
Stephen Finucane
a33483f154 docs: Add release process document
This is based on content extracted from the CONTRIBUTING document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Stephen Finucane
6b19678253 docs: Add organization overview
Provide an introduction to how the Sphinx team is organized. This will
be expanded upon in a future change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00
Stephen Finucane
6a5921d7b2 docs: Add "project internals" guide
This is modelled off Django's guide of the same name [1]. In summary,
this will contain most of the information previously found in the
CONTRIBUTING document. For now, we move just the code of conduct and
authors documents.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-06-02 11:43:44 +01:00