如何将文档添加到 TYPO3 扩展
Howto add documentation to TYPO3 Extension
是否有如何向 TYPO3 扩展添加文档的分步手册？
我向存储库添加了两个扩展，但我也想添加一些文档。在 TYPO3 存储库的早期，这很容易 - 据我所知，必须将 OpenOffice 文档添加到扩展中......
我找到了这个 "howto"
我使用的是 macOS Sierra，我安装了很多东西：Xcode、MacPorts、Sphinx、...
但是在 github.com/marble/typo3-docs-typo3-org-resources 的文档目录的 _make 目录中调用 make 得到以下
错误：
sphinx-build -b html -d build/doctrees -c . -a -E -w
./_not_versioned/warnings.txt .. build/html Running Sphinx v1.5.1
Exception occurred: File "conf.py", line 24, in
import t3SphinxThemeRtd ImportError: No module named t3SphinxThemeRtd
The full traceback has been saved in /tmp/sphinx-err-bGi8t6.log, if
you want to report the issue to the developers. Please also report
this if it was a user error, so that a better error message can be
provided next time. A bug report can be filed in the tracker at
https://github.com/sphinx-doc/sphinx/issues. Thanks!
所以虽然我用 pip 命令添加了模块 t3SphinxThemeRtd 却没有找到！？
有没有简单的添加文档的方法？我认为这个复杂的过程将阻止许多开发人员向他们的扩展添加文档！？
您无需设置 Sphinx 即可编写文档。
文档是纯文本文件，因此没有什么可以阻止您。
不过，当您想测试文档时，Sphinx 很有用。
我已将您的错误报告给负责文档的 Martin Bless，他将更新指南或尽快与您联系。
如前所述，您不需要在本地呈现您的文档，即使它可以让生活更轻松。
使用 sphinx: 如果你想写第一个文件，看看基本的例子，比如 https://github.com/georgringer/eventnews or https://github.com/sup7even/mailchimp/tree/master/Documentation
单个文件：但是你甚至可以编写更简单的文档。看看https://github.com/georgringer/page_speed/blob/master/README.rst which is a single file and then rendered as well https://docs.typo3.org/typo3cms/extensions/page_speed/。
Markdown:如果你不放心休息，可以直接在扩展目录下放一个README.md，然后渲染为嗯！
可以在此处找到编写文档的完整文档：https://docs.typo3.org/typo3cms/CoreApiReference/ExtensionArchitecture/Documentation/Index.html
Christian，你完全走在正确的轨道上：是的，提供一些好的文档！越来越多的人真的这样做了。所以我敢肯定，2017 年将是文档突破的一年。
一般来说这是最低要求：将文件 ./Documentation/Index.rst 添加到您的扩展名并在其中编写您的文档。使用 reStructuredText 作为标记。
快速入门：
为了更好地开始更多的花里胡哨，这就是你真正此刻应该做的事情：
让自己成为看起来像 https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-000/.
阅读启动器的首页以了解其工作原理。
比如这一个是为你预留的：https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-041/
直接在 Github 编辑。只需做一点更新并保存 (=push)，几分钟后您可以重新加载页面并查看服务器为您呈现的内容。您不必自己安装或渲染任何东西。服务器会为您完成。
或像往常一样使用 Github。
要成为该项目的所有者，请与您一起发送邮件 Github 用户名 到文档团队@typo3.org 和请求一个 T3DocumentationStarter 项目。
稍后：将入门项目的 ./Documentation 文件夹复制到您的扩展。编写文档。编辑 ./Documentation/Settings.cfg 中的元数据，您就完成了。
来到文档的阳光面 - 玩得开心！
不要创建 OpenOffice 文档。您不需要在本地安装 sphinx！ （尽管如果你愿意，没有人可以阻止你）。您可以使用提供的 Docker 图像 ，它为您提供了一个用于呈现文档的完整工作环境。
写扩展文档的官方文档已更新：
你需要什么文件？
您的扩展程序应该有一个目录 Documentation，其中应该包含作为 reStructuredText (.rst) 文档的文档（例如 Index.rst）。还支持降价。或者，您可以有一个单一文件的解决方案（例如，只有 Readme.rst）。
创建扩展文档有几个选项：
- 上面有一个example extension manual. How to use this to start your documentation from scratch is already described in the link我给的
- 或者，从头开始您的 ReST 文件
- 或者，使用现有的扩展来获取灵感，例如ext:form
- 或者，使用 extension builder（将 Documentation.tmpl 目录重命名为 Documentation ).
如何编辑 .rst 文件
您可以在简单的文本编辑器或 IDE 中编辑文件（最好使用支持 reStructuredText 的 IDE，例如对于 PhpStorm，使用 reStructuredText 插件，对于 Visual Studio代码，使用 LeXtudio reStructuredText 插件）。
- 提示 1：阅读 reStructuredText & Sphinx Introduction
- 技巧 2：使用 reST & Sphinx Cheat Sheet
- 提示 3：阅读 Common Pitfalls 以避免错误
渲染 ReST 文件
如果您想测试您的 reST 文件的外观，您应该在本地渲染它们。
为此你有 several options，但推荐的方法是使用 Docker。
是否有如何向 TYPO3 扩展添加文档的分步手册？ 我向存储库添加了两个扩展，但我也想添加一些文档。在 TYPO3 存储库的早期，这很容易 - 据我所知，必须将 OpenOffice 文档添加到扩展中...... 我找到了这个 "howto"
我使用的是 macOS Sierra，我安装了很多东西：Xcode、MacPorts、Sphinx、...
但是在 github.com/marble/typo3-docs-typo3-org-resources 的文档目录的 _make 目录中调用 make 得到以下
错误：
sphinx-build -b html -d build/doctrees -c . -a -E -w ./_not_versioned/warnings.txt .. build/html Running Sphinx v1.5.1
Exception occurred: File "conf.py", line 24, in import t3SphinxThemeRtd ImportError: No module named t3SphinxThemeRtd
The full traceback has been saved in /tmp/sphinx-err-bGi8t6.log, if you want to report the issue to the developers. Please also report this if it was a user error, so that a better error message can be provided next time. A bug report can be filed in the tracker at https://github.com/sphinx-doc/sphinx/issues. Thanks!
所以虽然我用 pip 命令添加了模块 t3SphinxThemeRtd 却没有找到！？
有没有简单的添加文档的方法？我认为这个复杂的过程将阻止许多开发人员向他们的扩展添加文档！？
您无需设置 Sphinx 即可编写文档。 文档是纯文本文件，因此没有什么可以阻止您。
不过，当您想测试文档时，Sphinx 很有用。 我已将您的错误报告给负责文档的 Martin Bless，他将更新指南或尽快与您联系。
如前所述，您不需要在本地呈现您的文档，即使它可以让生活更轻松。
使用 sphinx: 如果你想写第一个文件，看看基本的例子，比如 https://github.com/georgringer/eventnews or https://github.com/sup7even/mailchimp/tree/master/Documentation
单个文件：但是你甚至可以编写更简单的文档。看看https://github.com/georgringer/page_speed/blob/master/README.rst which is a single file and then rendered as well https://docs.typo3.org/typo3cms/extensions/page_speed/。
Markdown:如果你不放心休息，可以直接在扩展目录下放一个
README.md，然后渲染为嗯！
可以在此处找到编写文档的完整文档：https://docs.typo3.org/typo3cms/CoreApiReference/ExtensionArchitecture/Documentation/Index.html
Christian，你完全走在正确的轨道上：是的，提供一些好的文档！越来越多的人真的这样做了。所以我敢肯定，2017 年将是文档突破的一年。
一般来说这是最低要求：将文件 ./Documentation/Index.rst 添加到您的扩展名并在其中编写您的文档。使用 reStructuredText 作为标记。
快速入门：
为了更好地开始更多的花里胡哨，这就是你真正此刻应该做的事情：
让自己成为看起来像 https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-000/.
的 T3DocumentationStarter 项目之一
阅读启动器的首页以了解其工作原理。
比如这一个是为你预留的：https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-041/
直接在 Github 编辑。只需做一点更新并保存 (=push)，几分钟后您可以重新加载页面并查看服务器为您呈现的内容。您不必自己安装或渲染任何东西。服务器会为您完成。
或像往常一样使用 Github。
要成为该项目的所有者，请与您一起发送邮件 Github 用户名 到文档团队@typo3.org 和请求一个 T3DocumentationStarter 项目。
稍后：将入门项目的 ./Documentation 文件夹复制到您的扩展。编写文档。编辑 ./Documentation/Settings.cfg 中的元数据，您就完成了。
来到文档的阳光面 - 玩得开心！
不要创建 OpenOffice 文档。您不需要在本地安装 sphinx！ （尽管如果你愿意，没有人可以阻止你）。您可以使用提供的 Docker 图像 ，它为您提供了一个用于呈现文档的完整工作环境。
写扩展文档的官方文档已更新：
你需要什么文件？
您的扩展程序应该有一个目录 Documentation，其中应该包含作为 reStructuredText (.rst) 文档的文档（例如 Index.rst）。还支持降价。或者，您可以有一个单一文件的解决方案（例如，只有 Readme.rst）。
创建扩展文档有几个选项：
- 上面有一个example extension manual. How to use this to start your documentation from scratch is already described in the link我给的
- 或者，从头开始您的 ReST 文件
- 或者，使用现有的扩展来获取灵感，例如ext:form
- 或者，使用 extension builder（将 Documentation.tmpl 目录重命名为 Documentation ).
如何编辑 .rst 文件
您可以在简单的文本编辑器或 IDE 中编辑文件（最好使用支持 reStructuredText 的 IDE，例如对于 PhpStorm，使用 reStructuredText 插件，对于 Visual Studio代码，使用 LeXtudio reStructuredText 插件）。
- 提示 1：阅读 reStructuredText & Sphinx Introduction
- 技巧 2：使用 reST & Sphinx Cheat Sheet
- 提示 3：阅读 Common Pitfalls 以避免错误
渲染 ReST 文件
如果您想测试您的 reST 文件的外观，您应该在本地渲染它们。
为此你有 several options，但推荐的方法是使用 Docker。