Commit Graph

3079 Commits

Author SHA1 Message Date
igo95862
a56f69b916 doc: Added autodoc extension tutorial to tutorials index 2021-03-09 17:57:30 +03:00
igo95862
1ac05a2a83 doc: Create autodoc extension tutorial 2021-03-09 17:56:46 +03:00
Takeshi KOMIYA
ff49bfa003 Merge pull request #8947 from tk0miya/deprecate_registry.get_source_input
Deprecate SphinxComponentRegistry.get_source_input()
2021-03-05 00:06:05 +09:00
Takeshi KOMIYA
61c9c7fc58 Deprecate SphinxComponentRegistry.get_source_input()
The source_input system was deprecated at v2.0.  So no client uses it
longer now.  Therefore this deprecate the getter interface and its
usage.
2021-03-02 21:18:31 +09:00
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +09:00
jfbu
62401ef1ec Merge branch '3.x' 2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen
a7fcc15683 C++, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
06a956200b C, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
d0a4d0147e C++, add recursiveness to alias
Fixes sphinx-doc/sphinx#8213 in the most basic way.
2021-02-12 17:25:12 +01:00
Takeshi KOMIYA
61af7f48ad Merge pull request #8873 from tk0miya/8860_bad_example
Fix #8860: doc: Usage of recipe directive is wrong
2021-02-13 01:04:27 +09:00
Takeshi KOMIYA
def6f13d8d Merge branch '3.x' 2021-02-13 01:01:30 +09:00
Takeshi KOMIYA
3b451bbcde Merge pull request #8835 from tk0miya/refactor_linkcheck7
refactor: linkcheck: Separate thread manager feature from builder class
2021-02-12 23:32:30 +09:00
Takeshi KOMIYA
5c223d20d6 refactor: linkcheck: Separate thread manager feature from builder class
To reduce the complexity of the linkcheck builder, this separates
the thread manager feature from the builder class as
HyperlinkAvailabilityChecker.
2021-02-12 23:19:01 +09:00
Takeshi KOMIYA
d5de7bf3cf Fix #8860: doc: Usage of recipe directive is wrong 2021-02-12 20:51:53 +09:00
Takeshi KOMIYA
f17ab57b64 Fix #8860: doc: recipe directive crashes with AttributeError
The pre check in the `ReceipeDirective.add_target_and_index() was wrong.
It checkes non-existing option "noindex", but it should check "contains"
option instead.
2021-02-11 22:13:07 +09:00
jfbu
b9c53c8ca6 Merge branch '3.x' into merge_3.x_into_master
Resolved Conflicts:
	sphinx/texinputs/sphinx.sty

Some hunks needed to go to sphinx/texinputs/sphinxlatexliterals.py,
others already belonged to split files.
2021-02-09 19:03:38 +01:00
jfbu
87d0b15eab Also indent warning to not interrupt description list 2021-02-09 18:29:56 +01:00
jfbu
a310c4c5b6 Indent note directive inside list item 2021-02-09 18:25:37 +01:00
jfbu
32d8b4e445 Minor refactoring in doc/latex.rst 2021-02-09 18:11:24 +01:00
Jean-François B
1c08467040 Merge pull request #8851 from jfbu/latex_enhance_docs_about_index
LaTeX: improve docs of 'printindex' and 'makeindex'
2021-02-09 16:16:26 +01:00
Jean-François B
86ea2a93e0 Merge pull request #8854 from jfbu/latex_longstringsincodeblocks
LaTeX: optionally apply a second forceful wrapping of long code lines
2021-02-09 16:14:48 +01:00
jfbu
aaac721104 Typo 2021-02-09 16:04:01 +01:00
jfbu
035d13fd24 Update CHANGES and docs relative to new verbatimforcewraps 2021-02-09 15:47:15 +01:00
Takeshi KOMIYA
208f549b8a Merge branch '3.x' 2021-02-09 22:43:14 +09:00
jfbu
eee17ff61a Fix forgotten link to Pygments home site, mmmmpf 2021-02-09 12:33:16 +01:00
jfbu
abddafa98a Fix inexistent directive "notice", it is "note"... 2021-02-09 12:28:03 +01:00
jfbu
c6a8fb1625 Add verbatimmaxoverfull and verbatimmaxunderfull 2021-02-09 12:18:31 +01:00
jfbu
0076ad3fd3 Indicated force wrapping code lines is fragile with Unicode input 2021-02-09 00:01:39 +01:00
jfbu
702545da1c LaTeX: optionally apply a second forceful wrapping of long code lines
Closes #8849
2021-02-08 23:13:46 +01:00
jfbu
a984f5f7cc LaTeX: improve docs of 'printindex' and 'makeindex'
Closes #8055
2021-02-08 14:59:20 +01:00
Harrissou Sant-anna
08c2c23bb4 Make code block types more visible 2021-02-08 13:03:16 +01:00
Takeshi KOMIYA
4cbb2925fd Fix #8837: doc: Remove version info from html_title 2021-02-07 21:24:15 +09:00
Takeshi KOMIYA
84458da828 Merge branch '3.x' 2021-02-07 17:01:09 +09:00
Takeshi KOMIYA
899ccfd40e refactor: linkcheck: Deprecate attributes of linkcheck builders
Move anchors_ignore, auth and to_ignore to
HyperlinkAvailabilityCheckWorker and become deprecated.
2021-02-07 02:39:35 +09:00
Thibaud Colas
00e2c2e250 Fix broken "Extend" link in site header
Spotted while navigating https://www.sphinx-doc.org/en/master/.
2021-02-04 22:04:17 +00:00
jfbu
87fa272763 Merge branch '3.x' into merge_3.x_into_master
Resolved Conflicts:
	sphinx/texinputs/sphinxpackagefootnote.sty
2021-02-04 16:31:45 +01:00
jfbu
fbafb308b8 Merge branch '3.x' into master_with_merged_3.x 2021-02-02 18:01:55 +01:00
pbudzyns
270921d73a Merge remote-tracking branch 'upstream/3.x' into exclude-members-fix 2021-02-01 10:46:44 +01:00
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
Takeshi KOMIYA
804e46e27b Merge pull request #8785 from tk0miya/8783_update_doc
doc: Update doc for project_copyright (refs: #8783)
2021-01-31 14:27:42 +09:00
jfbu
c07adc4ebb Fix docs markup from d6e11b89
Sorry that I fixed this in master already, forgetting it was initially
merged into 3.x.
2021-01-30 21:17:07 +01:00
jfbu
6dea091257 Fix markup in docs (from d6e11b89) 2021-01-30 21:14:02 +01:00
Takeshi KOMIYA
339ce2f894 Merge branch '3.x' 2021-01-30 11:49:08 +09:00
Takeshi KOMIYA
ffe8fbf271 doc: Update doc for project_copyright (refs: #8783) 2021-01-30 11:38:16 +09:00
jfbu
d6e11b89e9 Fix suppression of needed whiteline, encapsulate into \sphinxAtStartPar
Define it to do nothing with lualatex engine
2021-01-29 10:40:50 +01:00
jfbu
185a2d27fe Fix #8780: long words in narrow columns may not be hyphenated
This is done by adding '\hskip0pt\relax\n' whenever a paragraph starts.
2021-01-29 00:24:44 +01:00
jfbu
365ae80cc4 Revert alteration at c9480f994 merge of 3.x of doc/conf.py
Compare doc/conf.py after merge at c9480f994 to what it was at 2ee033838.

It loses the modification from #8716 (merged at 38c614347) and thus
reverts doc/conf.py to former font config using mathpazo.
2021-01-27 18:44:56 +01:00
jfbu
af2949c654 Merge branch 'master' into refactor_latex_into_multiple_files 2021-01-27 17:02:00 +01:00
Takeshi KOMIYA
c9480f9943 Merge branch '3.x' 2021-01-28 00:56:46 +09:00
jfbu
6e80d27841 Refactor LaTeX [1/2]: split sphinx.sty into separate components
The latex macros from sphinx.sty were already partitioned into
successive sections.  The file sphinx.sty is split into multiple
files in concordance with this pre-existing sectioning.

The files are loaded via \input. File extension is .sty not .tex
to not confuse the Makefile.
2021-01-27 15:58:48 +01:00