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,877 Commits 2 Branches 219 Tags 163 MiB
6845c3fd96
Commit Graph

19877 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Adam Turner
7d67371f38
Update .readthedocs.yml configuration (#10874) 2022-09-27 16:00:57 +01:00
Adam Turner
8accc34966 Merge branch '5.2.x' into 5.x 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2022-09-27 15:58:00 +01:00
Adam Turner
a651e6bf4a Bump to 5.2.2 final 2022-09-27 15:54:01 +01:00
Adam Turner
335f335a58 Restore anchor links to top of module docstring 2022-09-27 15:53:38 +01:00
Adam Turner
19c278313b Correct error in release date for Sphinx 5.2.1 2022-09-27 15:51:46 +01:00
Adam Turner
635540c180 Restore anchor links to top of module docstring 2022-09-27 15:48:54 +01:00
Adam Turner
89b4f14b44
Fix mypy violations for v0.981 (#10875) 2022-09-27 15:18:20 +01:00
Hugo van Kemenade
d5b28997f2
Declare support for Python 3.11 (#10871) 2022-09-27 14:21:55 +01:00
Jean-François B
92a508a10f
Merge pull request #10783 from sphinx-doc/bot/pull-translations 
Update message catalogs
 2022-09-26 21:43:29 +02:00
Stephen Finucane
49eeb0e846 Validate filenames in builder 
This moves the logic for checking filenames closer to where it's
actually used.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2022-09-26 17:50:57 +01:00
Stephen Finucane
9ab21ce51a Combine 'compile_xxx' and 'build_xxx' functions 
These are only called from the one location and we already use 'build'
to do both building and writing. Given that we intend to simplify the
handling of the 'filenames' argument, this makes our lives there much
easier.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2022-09-26 17:50:57 +01:00
Stephen Finucane
6adbb006f9 Use path2doc rather than reinventing the wheel 
We already have a helper function that allows us to convert a filename
to a "docname". Don't reinvent the wheel and simply use this when
building specific files with Sphinx. Note that this does change behavior
slightly, insofar as filenames that don't resolve to valid docnames will
now be ignored rather than being passed with their suffix and silently
ignored later, but that seems sane.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2022-09-26 17:50:57 +01:00
Adam Turner
f01d50d695 Merge branch '5.x' 
# Conflicts:
#	CHANGES
#	doc/conf.py
#	sphinx/__init__.py
#	sphinx/builders/html/__init__.py
#	sphinx/domains/python.py
#	tests/test_build_html.py
 2022-09-25 21:36:30 +01:00
Adam Turner
eb5b3aa25d Merge branch '5.2.x' into 5.x 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2022-09-25 21:33:04 +01:00
Adam Turner
e0dbbc510a Bump to 5.2.1 final 2022-09-25 20:39:57 +01:00
Adam Turner
15c1cba28e Fix error in changelog for Sphinx 5.2.0 2022-09-25 20:39:57 +01:00
Adam Turner
77cee67f11 Define extra indent as a class attribute 2022-09-25 20:23:53 +01:00
tk0miya
819ad1bfe0 Update message catalogs 2022-09-25 00:23:49 +00:00
Adam Turner
9ced736316 Fix highlighting lexers 
- Ensure `pycon3` is always normalised to `pycon`
 2022-09-25 00:10:59 +01:00
Adam Turner
cd24c54144 Bump to 5.2.0.post0 final 2022-09-24 22:26:39 +01:00
Jean-François B
a34a34fe53 Mumble (line too long but this is raw LaTeX, and we should be exempted) 2022-09-24 23:17:34 +02:00
Jean-François B
464d0815e9 [DOC] Avoid collisions in TOC of sphinx.pdf in Changelog chapter 
Relates #10858
 2022-09-24 23:09:31 +02:00
Adam Turner
0273e68974 Update release-checklist tagging guidance 2022-09-24 21:59:18 +01:00
Adam Turner
911a5fe8bb Bump to 5.2.0 final 2022-09-24 21:55:52 +01:00
Adam Turner
68dd1b12e2 Bump version 2022-09-24 21:55:52 +01:00
Adam Turner
bc59a1d1de Merge 5.1.2 CHANGES into 5.2.0 2022-09-24 21:55:52 +01:00
Jean-François B
2f2bd551c4
Merge pull request #10859 from jfbu/latex_doc_tableofcontentshook 
LaTeX: improve doc of \sphinxtableofcontents (closes #10858)
 2022-09-24 22:42:44 +02:00
Jean-François B
89a656dec4 LaTeX: improved doc of \sphinxtableofcontents (closes #10858) 2022-09-24 22:32:07 +02:00
Arthur Milchior
65081218ce
Docstring clarifications (#9877) 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-09-24 15:30:57 +01:00
danieleades
b842cabd4f
Add a new mypy whitelist for 'Any generics' (#10845) 2022-09-24 15:12:01 +01:00
Adam Turner
e2b3b3f060 Move to localStorage for search highlighting 2022-09-24 15:10:57 +01:00
Adam Turner
c7c0e4048d Split out sphinx_highlight.js 2022-09-24 15:10:57 +01:00
Adam Turner
8db24515ea
Clear record_dependencies for each document (#10855) 2022-09-24 00:31:26 +01:00
Martin Liška
73a1ee4560
search: use both title and subtitle only if different (#10848) 2022-09-23 18:57:14 +01:00
Martin Liška
25cbe68c11
Fix IndexLoader.load() for _all_titles (#10851) 
When there is a document with no entry in _all_titles, we must add empty array
when loading from frozenset.
 2022-09-23 18:49:25 +01:00
Adam Turner
5ce15606dd
Warn on using the :property: flag with .. py:method:: (#10852) 2022-09-23 18:47:28 +01:00
Adam Turner
58a4449707
Deprecate HTML 4 support (#10843) 2022-09-23 18:12:54 +01:00
Adam Turner
7ad0fcf22d Drop Python 3.6 support (pyproject.toml) 2022-09-23 17:29:05 +01:00
Adam Turner
56aa3412ef Merge branch '5.x' 
# Conflicts:
#	setup.py
#	sphinx/__init__.py
 2022-09-23 17:27:00 +01:00
Julien Schueller
ef01c5b6bd
imgmath: Allow embedding images in HTML as base64 (#10816) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-09-23 17:11:21 +01:00
Christian Clauss
cb77162144
Migrate configs for isort, mypy, and pytest into pyproject.toml (#10844) 2022-09-21 18:46:30 +01:00
Martin Liška
ac8cb6b4ca
Use both title and subtitle name in search results (#10824) 2022-09-21 16:02:40 +01:00
danieleades
9b65adc50c
Shrink strict optional whitelist (HTML writers) (#10838) 2022-09-20 22:26:39 +01:00
Adam Turner
8ae81839be
Support searching for index entries (#10819) 2022-09-20 22:08:03 +01:00
Steffen Rehberg
56fd7fb8ae
Fix get_terminal_width on Windows (#10842) 
`shutil.get_terminal_size` works as a drop-in replacement for
`get_terminal_width`, enabling accurate widths on Windows.
 2022-09-20 22:06:25 +01:00
danieleades
276f430b57
Begin addding flake8-simplify checks (#10820) 
Start with SIM104 and ignore all other flake8-simplify warnings
 2022-09-20 21:30:31 +01:00
Adam Turner
d043d96b09
Fix section numbering in domain object contents entries (#10830) 2022-09-20 21:10:55 +01:00
Adam Turner
c0efd347cb
Fix nesting in domain object contents entries (#10828) 2022-09-20 21:10:20 +01:00
Adam Turner
f57177de89
Add contents entries for domain objects (#10807) 
- Add entries in the table of contents for domain objects (e.g. 
  `py:function`, `rst:role`, etc). Supported domains are Javascript,
  Python, and reStructuredText.
- Support content in `py:module` and `js:module` directives.
- Add the `noindexentry` and `noindex` flags to more domains.
- Add `toc_object_entries_show_parents` configuration setting
- Update documentation and tests
 2022-09-13 20:20:02 +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