贡献文档#
如果你贡献了一个新的转换器，或者增强了当前转换器的功能，很可能，你还需要添加或更新文档。
这是 Feature-engine 的文档生态系统：
Feature-engine 文档是使用 Sphinx 构建的，并托管在 Read the Docs 上。
我们使用 pydata sphinx 主题。
我们遵循 PEP 257 的文档字符串约定，并使用 numpydoc 文档字符串风格。
所有文档文件都位于仓库中的 docs 文件夹 内。
要了解更多关于Sphinx的信息，请查看 Sphinx快速入门文档。
文档组织#
Feature-engine 刚刚采用了 Scikit-learn 的文档风格，我们提供了 API 文档，以及一个包含如何使用不同转换器示例的用户指南。
API 文档是直接从每个转换器的 docstring 构建的。如果你正在添加一个新的转换器，你需要在一个放置在 api_doc 文件夹 中的新 rst 文件中引用它。
如果你想添加额外的示例，你需要更新位于 user_guide 文件夹 中的 rst 文件。
文档字符串#
开始编写transformer文档字符串的最快方法是查看Feature-engine中我们已有的一些类的文档字符串。然后简单地复制并粘贴这些文档字符串，并编辑你需要修改的部分。如果你复制并粘贴，请确保删除不相关的参数和方法。
链接一个新的变压器#
如果你从头编写了一个新的转换器，你需要更新以下文件，以确保用户能够找到如何正确使用该类的信息：
在这些文件中添加你的转换器的名称：
在这些文件夹中添加一个以你的转换器命名的rst文件：
就是这样！
扩展用户指南#
您可以为当前的用户指南示例添加更多示例或更多细节。首先，找到您想要处理的转换器的相关rst文件。请随意在方法描述中添加更多细节，扩展代码以展示其他参数，或添加您认为合适的任何内容。
我们通常在 Jupyter 笔记本上运行代码，然后将代码和输出复制粘贴到 rst 文件中。
构建文档#
要构建文档，请确保您已正确安装了 Sphinx 和所需的依赖项。如果您按照我们在 贡献代码指南 中描述的那样设置了开发环境，您应该已经安装了这些。
或者，首先激活你的环境。然后导航到 Feature-engine 的根文件夹。现在安装文档的要求:
$ pip install -r docs/requirements.txt
要构建文档（并测试其是否正常工作），请运行:
$ sphinx-build -b html docs build
此命令告诉 Sphinx 文档文件位于“docs”文件夹中，而 HTML 文件应放置在“build”文件夹中。
如果一切正常，你可以使用浏览器打开位于 build 目录中的 html 文件。或者，你需要通过 sphinx 返回的错误信息进行故障排查。
祝你好运，如果遇到困难请联系！