Sphinx-Autodoc-Typehints 项目教程

Sphinx-Autodoc-Typehints 项目教程

sphinx-autodoc-typehints Type hints support for the Sphinx autodoc extension 项目地址: https://gitcode.com/gh_mirrors/sp/sphinx-autodoc-typehints

1. 项目的目录结构及介绍

sphinx-autodoc-typehints/
├── src/
│   └── sphinx_autodoc_typehints/
│       ├── __init__.py
│       └── ...
├── tests/
│   └── ...
├── .gitignore
├── .markdownlint.yaml
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── ignore-words.txt
├── pyproject.toml
├── tox.ini
└── whitelist.txt

目录结构介绍

• src/sphinx_autodoc_typehints/: 包含项目的主要源代码文件。

  • __init__.py: 模块的初始化文件。
  • 其他 Python 文件：实现项目功能的代码文件。

• tests/: 包含项目的测试代码文件。

• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。

• .markdownlint.yaml: 配置 Markdown 文件的 linting 规则。

• .pre-commit-config.yaml: 配置 pre-commit 钩子，用于在提交代码前执行检查。

• CHANGELOG.md: 记录项目的变更日志。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的介绍和使用说明。

• ignore-words.txt: 包含需要忽略的单词列表。

• pyproject.toml: 项目的配置文件，包含构建系统和依赖管理的信息。

• tox.ini: 配置 tox 工具，用于自动化测试和环境管理。

• whitelist.txt: 包含白名单中的单词列表。

2. 项目的启动文件介绍

项目的主要启动文件位于 src/sphinx_autodoc_typehints/ 目录下。其中，__init__.py 文件是模块的初始化文件，负责导入和初始化项目的主要功能。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是项目的配置文件，包含构建系统和依赖管理的信息。以下是该文件的部分内容示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = ["sphinx_autodoc_typehints"]

[tool.pytest.ini_options]
addopts = "--cov=sphinx_autodoc_typehints --cov-report=term-missing"

tox.ini

tox.ini 是配置 tox 工具的文件，用于自动化测试和环境管理。以下是该文件的部分内容示例：

[tox]
envlist = py37,py38,py39

[testenv]
deps =
    pytest
    pytest-cov
commands =
    pytest --cov=sphinx_autodoc_typehints --cov-report=term-missing

.pre-commit-config.yaml

.pre-commit-config.yaml 配置 pre-commit 钩子，用于在提交代码前执行检查。以下是该文件的部分内容示例：

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files

通过以上配置文件，可以确保项目的构建、测试和代码质量检查自动化进行。

sphinx-autodoc-typehints Type hints support for the Sphinx autodoc extension 项目地址: https://gitcode.com/gh_mirrors/sp/sphinx-autodoc-typehints