跳转到主要内容

Sphinx电子邮件混淆扩展

项目描述

[Latest PyPI version] [Supported Python versions] [pre-commit: enabled] [pre-commit.ci status] [Code style: black] [Code style: prettier]

此软件包提供了 sphinxcontrib.email,这是一个基于Sphinx的文档的电子邮件混淆器。

安装

  1. pip install sphinxcontrib-email

2021年12月23日之后将停止支持python 3.6。

配置

  1. conf.py 中,将 'sphinxcontrib.email' 添加到 extensions 列表。

    extensions = [ 'sphinxcontrib.email' ]

使用方法

自动模式

conf.py 中,设置

email_automode = True

以自动混淆所有 mailto 链接。

手动模式

要混淆电子邮件地址,请使用 email 角色进行混淆

:email:`Name Surname <user@myplace.org>`

显示为“姓名 姓氏”以及相应的 mailto 链接。

:email:`user@myplace.org`

显示为“user@myplace.org”以及相应的 mailto 链接

项目详情


下载文件

下载适用于您平台的项目文件。如果您不确定该选择哪一个,请了解更多关于安装包的信息。

源代码分发

sphinxcontrib_email-0.3.6.tar.gz (9.6 kB 查看哈希值)

上传时间 源代码

构建分发

sphinxcontrib_email-0.3.6-py3-none-any.whl (6.3 kB 查看哈希值)

上传时间 Python 3