mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '3.x' into typo
This commit is contained in:
@@ -195,8 +195,8 @@ Keys that you may want to override include:
|
||||
"Bjornstrup". You can also set this to ``''`` to disable fncychap.
|
||||
|
||||
Default: ``'\\usepackage[Bjarne]{fncychap}'`` for English documents,
|
||||
``'\\usepackage[Sonny]{fncychap}'`` for internationalized documents, and
|
||||
``''`` for Japanese documents.
|
||||
``'\\usepackage[Sonny]{fncychap}'`` for internationalized documents, and
|
||||
``''`` for Japanese documents.
|
||||
|
||||
``'preamble'``
|
||||
Additional preamble content. One may move all needed macros into some file
|
||||
@@ -300,7 +300,7 @@ Keys that don't need to be overridden unless in special cases are:
|
||||
"inputenc" package inclusion.
|
||||
|
||||
Default: ``'\\usepackage[utf8]{inputenc}'`` when using pdflatex, else
|
||||
``''``
|
||||
``''``
|
||||
|
||||
.. versionchanged:: 1.4.3
|
||||
Previously ``'\\usepackage[utf8]{inputenc}'`` was used for all
|
||||
@@ -389,7 +389,7 @@ Keys that don't need to be overridden unless in special cases are:
|
||||
key is ignored.
|
||||
|
||||
Default: ``'\\usepackage{textalpha}'`` or ``''`` if ``fontenc`` does not
|
||||
include the ``LGR`` option.
|
||||
include the ``LGR`` option.
|
||||
|
||||
.. versionadded:: 2.0
|
||||
|
||||
@@ -407,7 +407,7 @@ Keys that don't need to be overridden unless in special cases are:
|
||||
<latexsphinxsetup>`.
|
||||
|
||||
Default: ``'\\usepackage{geometry}'`` (or
|
||||
``'\\usepackage[dvipdfm]{geometry}'`` for Japanese documents)
|
||||
``'\\usepackage[dvipdfm]{geometry}'`` for Japanese documents)
|
||||
|
||||
.. versionadded:: 1.5
|
||||
|
||||
@@ -784,14 +784,14 @@ macros may be significant.
|
||||
|warningbdcolors|
|
||||
The colour for the admonition frame.
|
||||
|
||||
Default: ``{rgb}{0,0,0}`` (black)
|
||||
Default: ``{rgb}{0,0,0}`` (black)
|
||||
|
||||
.. only:: latex
|
||||
|
||||
|wgbdcolorslatex|
|
||||
The colour for the admonition frame.
|
||||
|
||||
Default: ``{rgb}{0,0,0}`` (black)
|
||||
Default: ``{rgb}{0,0,0}`` (black)
|
||||
|
||||
|warningbgcolors|
|
||||
The background colours for the respective admonitions.
|
||||
|
||||
@@ -23,12 +23,12 @@ from typing import Any, Dict, List, NamedTuple, Optional, Set, Tuple, cast
|
||||
from urllib.parse import unquote, urlparse
|
||||
|
||||
from docutils import nodes
|
||||
from docutils.nodes import Element, Node
|
||||
from docutils.nodes import Element
|
||||
from requests import Response
|
||||
from requests.exceptions import HTTPError, TooManyRedirects
|
||||
|
||||
from sphinx.application import Sphinx
|
||||
from sphinx.builders import Builder
|
||||
from sphinx.builders.dummy import DummyBuilder
|
||||
from sphinx.deprecation import RemovedInSphinx50Warning
|
||||
from sphinx.locale import __
|
||||
from sphinx.transforms.post_transforms import SphinxPostTransform
|
||||
@@ -98,7 +98,7 @@ def check_anchor(response: requests.requests.Response, anchor: str) -> bool:
|
||||
return parser.found
|
||||
|
||||
|
||||
class CheckExternalLinksBuilder(Builder):
|
||||
class CheckExternalLinksBuilder(DummyBuilder):
|
||||
"""
|
||||
Checks for broken external links.
|
||||
"""
|
||||
@@ -406,18 +406,6 @@ class CheckExternalLinksBuilder(Builder):
|
||||
lineno, uri + ' to ' + info)
|
||||
self.write_linkstat(linkstat)
|
||||
|
||||
def get_target_uri(self, docname: str, typ: str = None) -> str:
|
||||
return ''
|
||||
|
||||
def get_outdated_docs(self) -> Set[str]:
|
||||
return self.env.found_docs
|
||||
|
||||
def prepare_writing(self, docnames: Set[str]) -> None:
|
||||
return
|
||||
|
||||
def write_doc(self, docname: str, doctree: Node) -> None:
|
||||
pass
|
||||
|
||||
def write_entry(self, what: str, docname: str, filename: str, line: int,
|
||||
uri: str) -> None:
|
||||
with open(path.join(self.outdir, 'output.txt'), 'a') as output:
|
||||
|
||||
Reference in New Issue
Block a user