documentation - 如何向 TYPO3 扩展添加文档

Question

是否有关于如何将文档添加到 TYPO3 扩展的分步手册？我向存储库添加了两个扩展，但我也想添加一些文档。在 TYPO3 存储库的早期阶段，这非常简单 - 据我所知，必须将 OpenOffice 文档添加到扩展中......我找到了这个"howto"

我使用的是 macOS Sierra，并且安装了很多东西:Xcode、MacPorts、Sphinx...

我都做了these pip installs

但是在 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 模块，但没有找到它!？

有没有简单的方法来添加文档？我认为这个复杂的过程将阻止许多开发人员向他们的扩展添加文档!？

Answer 1

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 上编辑。只需进行一些更新并保存(=推送)，几分钟后您就可以重新加载页面并查看服务器为您呈现的内容。您不必自己安装或渲染任何东西。服务器将为您执行此操作。

• 或者像平常一样使用 Github。

• 要成为该项目的所有者，请将您的 Github 用户名发送到文档团队的邮件至 Documentation@typo3.org，并请求 T3DocumentationStarter 项目。

• 稍后:将起始项目的 ./Documentation 文件夹复制到您的扩展中。写你的文档。编辑 ./Documentation/Settings.cfg 中的元数据即可完成。

来看看文档的阳光一面 - 玩得开心!

PS:现已上线https://docs.typo3.org/Tips/TipOfTheDay/Index.html#how-to-start-documentation-for-your-typo3-extension还有