Welcome to mirror list, hosted at ThFree Co, Russian Federation.

apidoc.py « sphinx - github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 95a1d14f757a327dd899db15e9f7d68d7675b405 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# -*- coding: utf-8 -*-
"""
    sphinx.apidoc
    ~~~~~~~~~~~~~

    This file has moved to :py:mod:`sphinx.ext.apidoc`.

    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import sys
import warnings

from sphinx.deprecation import RemovedInSphinx20Warning
from sphinx.ext.apidoc import main as _main

if False:
    # For type annotation
    from typing import List  # NOQA
    from sphinx.application import Sphinx  # NOQA


def main(argv=sys.argv):
    # type: (List[str]) -> None
    warnings.warn(
        '`sphinx.apidoc.main()` has moved to `sphinx.ext.apidoc.main()`.',
        RemovedInSphinx20Warning,
        stacklevel=2,
    )
    _main(argv[1:])  # skip first argument to adjust arguments (refs: #4615)


# So program can be started with "python -m sphinx.apidoc ..."
if __name__ == "__main__":
    warnings.warn(
        '`sphinx.apidoc` has moved to `sphinx.ext.apidoc`.',
        RemovedInSphinx20Warning,
        stacklevel=2,
    )
    main()