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,417 Commits 2 Branches 219 Tags
de6d3665ef85b778756af3ed7fd714378ec73911
Commit Graph

847 Commits

Author SHA1 Message Date
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
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
ee005caf22 Do not apply epigraph style to all block quotes 
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.

Closes GH-10686
 2022-09-12 19:54:36 +01:00
Jean-François B
5c82449eca Merge branch '5.x' 2022-08-06 18:31:14 +02:00
Abdur-Rahmaan Janhangeer
59056aa781 Remove extra line (#10749) 
Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
 2022-08-04 18:42:55 +02:00
Adam Turner
19b54dce6a Merge branch '5.x' 
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
 2022-07-24 14:15:26 +01:00
Adam Turner
e3337c78c6 Update include_patterns implementation (#10680) 2022-07-23 21:19:35 +01:00
Takeshi KOMIYA
1199f7bd75 Merge branch '5.x' 2022-07-23 15:32:38 +09:00
marxin
9a30edac7d Fix indentation of .. version{changed,added}. 2022-07-19 15:26:57 +02: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
Adam Turner
a4d41aa889 Merge branch '5.x' 2022-07-17 21:53:12 +01:00
Adam Turner
490a8a9162 Add include_patterns as the opposite of exclude_patterns (#10518) 2022-07-17 21:44:33 +01:00
Jean-François B
80198e82aa Merge branch '5.x' into master 
Resolved merge conflicts:
    sphinx/ext/extlinks.py
    sphinx/ext/napoleon/docstring.py
    (and removed from the latter a now unused import for flake8 F401
    compliance)
 2022-06-30 15:00:16 +02:00
Adam Turner
ac0fc4b781 Remove more deprecated items in Sphinx 6.0 (#10562) 2022-06-26 15:01:09 +01:00
jfbu
d730c55f13 [DOC] Fix sectioning level in usage/configuration.rst 
The conf.py example ended up as sub-section of previous one
 2022-06-26 11:36:38 +02:00
jfbu
f74cc3fcaa Minor cross-linking improvements in usage/restructuredtext/roles.rst 2022-06-26 09:51:39 +02:00
jfbu
8ecbe8a15a Improve mark-up in docs (follow-up to PR #10366) 2022-06-26 09:30:22 +02:00
Brecht Machiels
7b0787485e Fix link to rinohtype manual (#10593) 2022-06-22 19:35:42 +01:00
Adam Turner
7e38d2dad8 Merge branch '5.x' 
# Conflicts:
#	.github/workflows/builddoc.yml
#	.github/workflows/lint.yml
#	sphinx/registry.py
 2022-06-16 21:46:54 +01:00
Adam Turner
70f950cae0 Remove traces of Python 2 and 3.5 (#10560) 2022-06-16 21:37:46 +01:00
Adam Turner
ce31e1c0c7 Remove deprecated items for Sphinx 6.0 (#10471) 2022-06-16 21:05:37 +01:00
Martin Liška
f789148fa2 Allow emphasising placeholders in option directives (#10366) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 20:46:01 +01:00
Takeshi KOMIYA
7e68154e49 Drop python 3.6 support (#10468) 2022-06-16 19:33:55 +01:00
Julien Palard
956cddb7d4 Replace doclinter with sphinx-lint (#10389) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-06-16 19:32:09 +01:00
Adam Turner
78c478a579 Merge remote-tracking branch 'upstream/5.0.x' into lang-none-en 2022-05-28 19:21:44 +01:00
Takeshi KOMIYA
68252c646a doc: The default setting of "language" has been changed since v5.0 2022-05-28 19:09:35 +01:00
Takeshi KOMIYA
06436084dd Merge pull request #10464 from tk0miya/10461_doc_code-block_class_option 
doc: Add an explanation for :class: option of code-block directive
 2022-05-28 23:15:08 +09:00
Takeshi KOMIYA
cab2d93076 Merge pull request #10386 from mxd4/10384-comment-img-magick 
Add comments on ImageMagick requirement
 2022-05-22 19:22:24 +09:00
Takeshi KOMIYA
1856ee638b Close #10461: doc: Add an explanation for :class: option of code-block directive 2022-05-22 16:03:33 +09:00
Takeshi KOMIYA
425a3e6c09 Merge branch '4.x' into 5.x 2022-05-06 03:32:43 +09:00
Takeshi KOMIYA
3805e0646f Merge pull request #10251 from jbms/fix-inline-syntax-highlight 
Make code role highlighting consistent with code-block directive
 2022-05-06 02:54:42 +09:00
Takeshi KOMIYA
538fdb23bb Merge pull request #10388 from soxofaan/patch-1 
sphinx.ext.napoleon docs: fix Google style link
 2022-05-03 01:53:58 +09:00
mxd4
33b5e23467 #10384 - Grammar 2022-05-02 13:56:51 +02:00
mxd4
4fc196a2a5 #10384 - Fix flake8 2022-05-02 12:26:16 +02:00
mxd4
4d840c790c #10384 - Explicit warning and improve doc clarity 2022-05-02 12:18:30 +02:00
mxd4
d2d5ce4eb6 #10384 - Changes after suggestions 2022-05-02 11:29:11 +02:00
mxd4
85524b5817 #10384 - Add line break to fix docslint 2022-05-02 11:15:29 +02:00
mxd4
930056479f #10384 - Add comment on ImageMagick requirement 2022-05-02 10:47:56 +02:00
Stefaan Lippens
b98b1b3419 sphinx.ext.napoleon docs: fix Google style link 2022-04-25 12:35:40 +02:00
Adam Turner
3420d15cb9 Bump Docutils dependency 2022-04-19 03:09:45 +01:00
Takeshi KOMIYA
da73960492 Merge branch '5.x' into autodoc_force_undocumented_rtype 2022-04-03 22:45:42 +09:00
Takeshi KOMIYA
fd42063725 autodoc_typehints_description_target: Rename returnvalue_and_documented_params to documented_params 2022-04-03 22:42:44 +09:00
Takeshi KOMIYA
f731bf1999 Merge branch '5.x' into autodoc_force_undocumented_rtype 2022-04-03 22:29:22 +09:00
Takeshi KOMIYA
21e3a96f09 Close #8417: autodoc: :inherited-members: option now takes multiple classes 
It allows to suppress inherited members of several classes on the module at
once by specifying the option to `automodule` directive
 2022-04-03 20:17:41 +09:00
Takeshi KOMIYA
223b1a94f2 Merge branch '4.x' 2022-03-28 01:00:37 +09:00
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
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +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