mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix module docstring indentation
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
"""The Sphinx documentation toolchain.
|
"""The Sphinx documentation toolchain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Keep this file executable as-is in Python 3!
|
# Keep this file executable as-is in Python 3!
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The Sphinx documentation toolchain.
|
"""The Sphinx documentation toolchain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Additional docutils nodes.
|
"""Additional docutils nodes.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, List, Sequence
|
from typing import TYPE_CHECKING, Any, Dict, List, Sequence
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
"""Sphinx application class and extensibility interface.
|
"""Sphinx application class and extensibility interface.
|
||||||
|
|
||||||
Gracefully adapted from the TextPress system by Armin.
|
Gracefully adapted from the TextPress system by Armin.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Builder superclass for all builders.
|
"""Builder superclass for all builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import pickle
|
import pickle
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Base class of epub2/epub3 builders.
|
"""Base class of epub2/epub3 builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import html
|
import html
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Changelog builder.
|
"""Changelog builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import html
|
import html
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Directory HTML builders.
|
"""Directory HTML builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Do syntax checks, but no writing.
|
"""Do syntax checks, but no writing.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, Set
|
from typing import Any, Dict, Set
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Build epub3 files.
|
"""Build epub3 files.
|
||||||
Originally derived from epub.py.
|
Originally derived from epub.py.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import html
|
import html
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The MessageCatalogBuilder class.
|
"""The MessageCatalogBuilder class.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from codecs import open
|
from codecs import open
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Several HTML builders.
|
"""Several HTML builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import html
|
import html
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Transforms for HTML builder.
|
"""Transforms for HTML builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""LaTeX builder.
|
"""LaTeX builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""consntants for LaTeX builder.
|
"""consntants for LaTeX builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict
|
from typing import Any, Dict
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Additional nodes for LaTeX writer.
|
"""Additional nodes for LaTeX writer.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from docutils import nodes
|
from docutils import nodes
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Theming support for LaTeX builder.
|
"""Theming support for LaTeX builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import configparser
|
import configparser
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Transforms for LaTeX builder.
|
"""Transforms for LaTeX builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List, Set, Tuple, cast
|
from typing import Any, Dict, List, Set, Tuple, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Utilities for LaTeX builder.
|
"""Utilities for LaTeX builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Optional
|
from typing import Optional
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The CheckExternalLinksBuilder class.
|
"""The CheckExternalLinksBuilder class.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Manual pages builder.
|
"""Manual pages builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Single HTML builders.
|
"""Single HTML builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Texinfo builder.
|
"""Texinfo builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Plain-text Sphinx builder.
|
"""Plain-text Sphinx builder.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Docutils-native XML and pseudo-XML builders.
|
"""Docutils-native XML and pseudo-XML builders.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
"""Modules for command line executables.
|
"""Modules for command line executables.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Build documentation from a provided source.
|
"""Build documentation from a provided source.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
"""sphinx-build -M command-line handling.
|
"""sphinx-build -M command-line handling.
|
||||||
|
|
||||||
This replaces the old, platform-dependent and once-generated content
|
This replaces the old, platform-dependent and once-generated content
|
||||||
of Makefile / make.bat.
|
of Makefile / make.bat.
|
||||||
|
|
||||||
This is in its own module so that importing it is fast. It should not
|
This is in its own module so that importing it is fast. It should not
|
||||||
import the main Sphinx modules (like sphinx.applications, sphinx.builders).
|
import the main Sphinx modules (like sphinx.applications, sphinx.builders).
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Quickly setup documentation source to work with Sphinx.
|
"""Quickly setup documentation source to work with Sphinx.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Build configuration file handling.
|
"""Build configuration file handling.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Sphinx deprecation classes and utilities.
|
"""Sphinx deprecation classes and utilities.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Handlers for additional ReST directives.
|
"""Handlers for additional ReST directives.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Support for domains, which are groupings of description directives
|
"""Support for domains, which are groupings of description directives
|
||||||
and roles describing e.g. constructs of one programming language.
|
and roles describing e.g. constructs of one programming language.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The C language domain.
|
"""The C language domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The changeset domain.
|
"""The changeset domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast
|
from typing import TYPE_CHECKING, Any, Dict, List, NamedTuple, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The citation domain.
|
"""The citation domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast
|
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Tuple, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The C++ language domain.
|
"""The C++ language domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The index domain.
|
"""The index domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple
|
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Tuple
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The JavaScript domain.
|
"""The JavaScript domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, Iterator, List, Optional, Tuple, cast
|
from typing import Any, Dict, Iterator, List, Optional, Tuple, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The math domain.
|
"""The math domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple
|
from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The Python domain.
|
"""The Python domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import builtins
|
import builtins
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The reStructuredText domain.
|
"""The reStructuredText domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The standard domain.
|
"""The standard domain.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Global creation environment.
|
"""Global creation environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
"""Sphinx environment adapters
|
"""Sphinx environment adapters
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Assets adapter for sphinx.environment.
|
"""Assets adapter for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from sphinx.environment import BuildEnvironment
|
from sphinx.environment import BuildEnvironment
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Index entries adapters for sphinx.environment.
|
"""Index entries adapters for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Toctree adapter for sphinx.environment.
|
"""Toctree adapter for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast
|
from typing import TYPE_CHECKING, Any, Iterable, List, Optional, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The data collector components for sphinx.environment.
|
"""The data collector components for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Dict, List, Optional, Set
|
from typing import TYPE_CHECKING, Dict, List, Optional, Set
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The image collector for sphinx.environment.
|
"""The image collector for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The dependencies collector components for sphinx.environment.
|
"""The dependencies collector components for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The metadata collector components for sphinx.environment.
|
"""The metadata collector components for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List, Set, cast
|
from typing import Any, Dict, List, Set, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The title collector components for sphinx.environment.
|
"""The title collector components for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, Set
|
from typing import Any, Dict, Set
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Toctree collector for sphinx.environment.
|
"""Toctree collector for sphinx.environment.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast
|
from typing import Any, Dict, List, Set, Tuple, Type, TypeVar, cast
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Contains SphinxError and a few subclasses (in an extra module to avoid
|
"""Contains SphinxError and a few subclasses (in an extra module to avoid
|
||||||
circular import problems).
|
circular import problems).
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
"""Sphinx core events.
|
"""Sphinx core events.
|
||||||
|
|
||||||
Gracefully adapted from the TextPress system by Armin.
|
Gracefully adapted from the TextPress system by Armin.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
"""Contains Sphinx features not activated by default.
|
"""Contains Sphinx features not activated by default.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
"""Parses a directory tree looking for Python modules and packages and creates
|
"""Parses a directory tree looking for Python modules and packages and creates
|
||||||
ReST files appropriately to create code documentation with Sphinx. It also
|
ReST files appropriately to create code documentation with Sphinx. It also
|
||||||
creates a modules index (named modules.<suffix>).
|
creates a modules index (named modules.<suffix>).
|
||||||
|
|
||||||
This is derived from the "sphinx-autopackage" script, which is:
|
This is derived from the "sphinx-autopackage" script, which is:
|
||||||
Copyright 2008 Société des arts technologiques (SAT),
|
Copyright 2008 Société des arts technologiques (SAT),
|
||||||
https://sat.qc.ca/
|
https://sat.qc.ca/
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
"""Automatically insert docstrings for functions, classes or whole modules into
|
"""Automatically insert docstrings for functions, classes or whole modules into
|
||||||
the doctree, thus avoiding duplication between docstrings and documentation
|
the doctree, thus avoiding duplication between docstrings and documentation
|
||||||
for those who like elaborate docstrings.
|
for those who like elaborate docstrings.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""The deprecated Documenters for autodoc.
|
"""The deprecated Documenters for autodoc.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import warnings
|
import warnings
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
"""
|
"""
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import warnings
|
import warnings
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Importer utilities for autodoc
|
"""Importer utilities for autodoc
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import importlib
|
import importlib
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""mock for autodoc
|
"""mock for autodoc
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import contextlib
|
import contextlib
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Preserve the default argument values of function signatures in source code
|
"""Preserve the default argument values of function signatures in source code
|
||||||
and keep them not evaluated for readability.
|
and keep them not evaluated for readability.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import ast
|
import ast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Update annotations info of living objects using type_comments.
|
"""Update annotations info of living objects using type_comments.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from inspect import Parameter, Signature, getsource
|
from inspect import Parameter, Signature, getsource
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Generating content for autodoc using typehints
|
"""Generating content for autodoc using typehints
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Allow reference sections by :ref: role using its title.
|
"""Allow reference sections by :ref: role using its title.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, cast
|
from typing import Any, Dict, cast
|
||||||
|
|||||||
@@ -1,51 +1,51 @@
|
|||||||
"""Sphinx extension that adds an autosummary:: directive, which can be
|
"""Sphinx extension that adds an autosummary:: directive, which can be
|
||||||
used to generate function/method/attribute/etc. summary lists, similar
|
used to generate function/method/attribute/etc. summary lists, similar
|
||||||
to those output eg. by Epydoc and other API doc generation tools.
|
to those output eg. by Epydoc and other API doc generation tools.
|
||||||
|
|
||||||
An :autolink: role is also provided.
|
An :autolink: role is also provided.
|
||||||
|
|
||||||
autosummary directive
|
autosummary directive
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
The autosummary directive has the form::
|
The autosummary directive has the form::
|
||||||
|
|
||||||
.. autosummary::
|
.. autosummary::
|
||||||
:nosignatures:
|
:nosignatures:
|
||||||
:toctree: generated/
|
:toctree: generated/
|
||||||
|
|
||||||
module.function_1
|
module.function_1
|
||||||
module.function_2
|
module.function_2
|
||||||
...
|
...
|
||||||
|
|
||||||
and it generates an output table (containing signatures, optionally)
|
and it generates an output table (containing signatures, optionally)
|
||||||
|
|
||||||
======================== =============================================
|
======================== =============================================
|
||||||
module.function_1(args) Summary line from the docstring of function_1
|
module.function_1(args) Summary line from the docstring of function_1
|
||||||
module.function_2(args) Summary line from the docstring
|
module.function_2(args) Summary line from the docstring
|
||||||
...
|
...
|
||||||
======================== =============================================
|
======================== =============================================
|
||||||
|
|
||||||
If the :toctree: option is specified, files matching the function names
|
If the :toctree: option is specified, files matching the function names
|
||||||
are inserted to the toctree with the given prefix:
|
are inserted to the toctree with the given prefix:
|
||||||
|
|
||||||
generated/module.function_1
|
generated/module.function_1
|
||||||
generated/module.function_2
|
generated/module.function_2
|
||||||
...
|
...
|
||||||
|
|
||||||
Note: The file names contain the module:: or currentmodule:: prefixes.
|
Note: The file names contain the module:: or currentmodule:: prefixes.
|
||||||
|
|
||||||
.. seealso:: autosummary_generate.py
|
.. seealso:: autosummary_generate.py
|
||||||
|
|
||||||
|
|
||||||
autolink role
|
autolink role
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
The autolink role functions as ``:obj:`` when the name referred can be
|
The autolink role functions as ``:obj:`` when the name referred can be
|
||||||
resolved to a Python object, and otherwise it becomes simple emphasis.
|
resolved to a Python object, and otherwise it becomes simple emphasis.
|
||||||
This can be used as the default role to make links 'smart'.
|
This can be used as the default role to make links 'smart'.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import inspect
|
import inspect
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
"""Usable as a library or script to generate automatic RST source files for
|
"""Usable as a library or script to generate automatic RST source files for
|
||||||
items referred to in autosummary:: directives.
|
items referred to in autosummary:: directives.
|
||||||
|
|
||||||
Each generated RST file contains a single auto*:: directive which
|
Each generated RST file contains a single auto*:: directive which
|
||||||
extracts the docstring of the referred item.
|
extracts the docstring of the referred item.
|
||||||
|
|
||||||
Example Makefile rule::
|
Example Makefile rule::
|
||||||
|
|
||||||
generate:
|
generate:
|
||||||
sphinx-autogen -o source/generated source/*.rst
|
sphinx-autogen -o source/generated source/*.rst
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Check Python modules and C API for coverage. Mostly written by Josip
|
"""Check Python modules and C API for coverage. Mostly written by Josip
|
||||||
Dzolonga for the Google Highly Open Participation contest.
|
Dzolonga for the Google Highly Open Participation contest.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import glob
|
import glob
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Mimic doctest by automatically executing code snippets and checking
|
"""Mimic doctest by automatically executing code snippets and checking
|
||||||
their results.
|
their results.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import doctest
|
import doctest
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Measure durations of Sphinx processing.
|
"""Measure durations of Sphinx processing.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime, timedelta
|
||||||
|
|||||||
@@ -1,24 +1,24 @@
|
|||||||
"""Extension to save typing and prevent hard-coding of base URLs in the reST
|
"""Extension to save typing and prevent hard-coding of base URLs in the reST
|
||||||
files.
|
files.
|
||||||
|
|
||||||
This adds a new config value called ``extlinks`` that is created like this::
|
This adds a new config value called ``extlinks`` that is created like this::
|
||||||
|
|
||||||
extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...}
|
extlinks = {'exmpl': ('https://example.invalid/%s.html', caption), ...}
|
||||||
|
|
||||||
Now you can use e.g. :exmpl:`foo` in your documents. This will create a
|
Now you can use e.g. :exmpl:`foo` in your documents. This will create a
|
||||||
link to ``https://example.invalid/foo.html``. The link caption depends on
|
link to ``https://example.invalid/foo.html``. The link caption depends on
|
||||||
the *caption* value given:
|
the *caption* value given:
|
||||||
|
|
||||||
- If it is ``None``, the caption will be the full URL.
|
- If it is ``None``, the caption will be the full URL.
|
||||||
- If it is a string, it must contain ``%s`` exactly once. In this case the
|
- If it is a string, it must contain ``%s`` exactly once. In this case the
|
||||||
caption will be *caption* with the role content substituted for ``%s``.
|
caption will be *caption* with the role content substituted for ``%s``.
|
||||||
|
|
||||||
You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.
|
You can also give an explicit caption, e.g. :exmpl:`Foo <foo>`.
|
||||||
|
|
||||||
Both, the url string and the caption string must escape ``%`` as ``%%``.
|
Both, the url string and the caption string must escape ``%`` as ``%%``.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""To publish HTML docs at GitHub Pages, create .nojekyll file.
|
"""To publish HTML docs at GitHub Pages, create .nojekyll file.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
"""Allow graphviz-formatted graphs to be included in Sphinx-generated
|
"""Allow graphviz-formatted graphs to be included in Sphinx-generated
|
||||||
documents inline.
|
documents inline.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import posixpath
|
import posixpath
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
"""Provides the ``ifconfig`` directive that allows to write documentation
|
"""Provides the ``ifconfig`` directive that allows to write documentation
|
||||||
that is included depending on configuration variables.
|
that is included depending on configuration variables.
|
||||||
|
|
||||||
Usage::
|
Usage::
|
||||||
|
|
||||||
.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')
|
.. ifconfig:: releaselevel in ('alpha', 'beta', 'rc')
|
||||||
|
|
||||||
This stuff is only included in the built docs for unstable versions.
|
This stuff is only included in the built docs for unstable versions.
|
||||||
|
|
||||||
The argument for ``ifconfig`` is a plain Python expression, evaluated in the
|
The argument for ``ifconfig`` is a plain Python expression, evaluated in the
|
||||||
namespace of the project configuration (that is, all variables from
|
namespace of the project configuration (that is, all variables from
|
||||||
``conf.py`` are available.)
|
``conf.py`` are available.)
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List
|
from typing import Any, Dict, List
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Image converter extension for Sphinx
|
"""Image converter extension for Sphinx
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Render math in HTML via dvipng or dvisvgm.
|
"""Render math in HTML via dvipng or dvisvgm.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import posixpath
|
import posixpath
|
||||||
|
|||||||
@@ -1,34 +1,34 @@
|
|||||||
r"""Defines a docutils directive for inserting inheritance diagrams.
|
r"""Defines a docutils directive for inserting inheritance diagrams.
|
||||||
|
|
||||||
Provide the directive with one or more classes or modules (separated
|
Provide the directive with one or more classes or modules (separated
|
||||||
by whitespace). For modules, all of the classes in that module will
|
by whitespace). For modules, all of the classes in that module will
|
||||||
be used.
|
be used.
|
||||||
|
|
||||||
Example::
|
Example::
|
||||||
|
|
||||||
Given the following classes:
|
Given the following classes:
|
||||||
|
|
||||||
class A: pass
|
class A: pass
|
||||||
class B(A): pass
|
class B(A): pass
|
||||||
class C(A): pass
|
class C(A): pass
|
||||||
class D(B, C): pass
|
class D(B, C): pass
|
||||||
class E(B): pass
|
class E(B): pass
|
||||||
|
|
||||||
.. inheritance-diagram: D E
|
.. inheritance-diagram: D E
|
||||||
|
|
||||||
Produces a graph like the following:
|
Produces a graph like the following:
|
||||||
|
|
||||||
A
|
A
|
||||||
/ \
|
/ \
|
||||||
B C
|
B C
|
||||||
/ \ /
|
/ \ /
|
||||||
E D
|
E D
|
||||||
|
|
||||||
The graph is inserted as a PNG+image map into HTML and a PDF in
|
The graph is inserted as a PNG+image map into HTML and a PDF in
|
||||||
LaTeX.
|
LaTeX.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import builtins
|
import builtins
|
||||||
|
|||||||
@@ -1,22 +1,22 @@
|
|||||||
"""Insert links to objects documented in remote Sphinx documentation.
|
"""Insert links to objects documented in remote Sphinx documentation.
|
||||||
|
|
||||||
This works as follows:
|
This works as follows:
|
||||||
|
|
||||||
* Each Sphinx HTML build creates a file named "objects.inv" that contains a
|
* Each Sphinx HTML build creates a file named "objects.inv" that contains a
|
||||||
mapping from object names to URIs relative to the HTML set's root.
|
mapping from object names to URIs relative to the HTML set's root.
|
||||||
|
|
||||||
* Projects using the Intersphinx extension can specify links to such mapping
|
* Projects using the Intersphinx extension can specify links to such mapping
|
||||||
files in the `intersphinx_mapping` config value. The mapping will then be
|
files in the `intersphinx_mapping` config value. The mapping will then be
|
||||||
used to resolve otherwise missing references to objects into links to the
|
used to resolve otherwise missing references to objects into links to the
|
||||||
other documentation.
|
other documentation.
|
||||||
|
|
||||||
* By default, the mapping file is assumed to be at the same location as the
|
* By default, the mapping file is assumed to be at the same location as the
|
||||||
rest of the documentation; however, the location of the mapping file can
|
rest of the documentation; however, the location of the mapping file can
|
||||||
also be specified individually, e.g. if the docs should be buildable
|
also be specified individually, e.g. if the docs should be buildable
|
||||||
without Internet access.
|
without Internet access.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import concurrent.futures
|
import concurrent.futures
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Add external links to module code in Python object descriptions.
|
"""Add external links to module code in Python object descriptions.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, Set
|
from typing import Any, Dict, Set
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
"""Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in
|
"""Allow `MathJax <https://www.mathjax.org/>`_ to be used to display math in
|
||||||
Sphinx's HTML writer -- requires the MathJax JavaScript library on your
|
Sphinx's HTML writer -- requires the MathJax JavaScript library on your
|
||||||
webserver/computer.
|
webserver/computer.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Support for NumPy and Google style docstrings.
|
"""Support for NumPy and Google style docstrings.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List
|
from typing import Any, Dict, List
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
Classes for docstring parsing and formatting.
|
Classes for docstring parsing and formatting.
|
||||||
|
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import collections
|
import collections
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
A collection of helpful iterators.
|
A collection of helpful iterators.
|
||||||
|
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import collections
|
import collections
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
"""Allow todos to be inserted into your documentation. Inclusion of todos can
|
"""Allow todos to be inserted into your documentation. Inclusion of todos can
|
||||||
be switched of by a configuration variable. The todolist directive collects
|
be switched of by a configuration variable. The todolist directive collects
|
||||||
all todos of your project and lists them along with a backlink to the
|
all todos of your project and lists them along with a backlink to the
|
||||||
original location.
|
original location.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import Any, Dict, List, Tuple, cast
|
from typing import Any, Dict, List, Tuple, cast
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Add links to module code in Python object descriptions.
|
"""Add links to module code in Python object descriptions.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import posixpath
|
import posixpath
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Utilities for Sphinx extensions.
|
"""Utilities for Sphinx extensions.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict
|
from typing import TYPE_CHECKING, Any, Dict
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Highlight code blocks using Pygments.
|
"""Highlight code blocks using Pygments.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Input/Output files
|
"""Input/Output files
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
import codecs
|
import codecs
|
||||||
from typing import TYPE_CHECKING, Any, List, Type
|
from typing import TYPE_CHECKING, Any, List, Type
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Glue code for the jinja2 templating engine.
|
"""Glue code for the jinja2 templating engine.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from os import path
|
from os import path
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Locale utilities.
|
"""Locale utilities.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import gettext
|
import gettext
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""A Base class for additional parsers.
|
"""A Base class for additional parsers.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import warnings
|
import warnings
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Utility function and classes for Sphinx projects.
|
"""Utility function and classes for Sphinx projects.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Utilities parsing and analyzing Python code.
|
"""Utilities parsing and analyzing Python code.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Helpers for AST (Abstract Syntax Tree).
|
"""Helpers for AST (Abstract Syntax Tree).
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Utilities parsing and analyzing Python code.
|
"""Utilities parsing and analyzing Python code.
|
||||||
|
|
||||||
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
|
||||||
:license: BSD, see LICENSE for details.
|
:license: BSD, see LICENSE for details.
|
||||||
"""
|
"""
|
||||||
import inspect
|
import inspect
|
||||||
import itertools
|
import itertools
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user