如何将文档添加到TYPO3扩展中

Question

是否有一步一步的手册如何将文档添加到TYPO3扩展中？ 我在存储库中添加了两个扩展，但我也想添加一些文档。在TYPO3仓库的早期时间，这很容易 - 据我记得OpenOffice文档必须添加到扩展... 我发现这"howto"

我使用macOS Sierra，我安装了一个很多东西：Xcode中，MacPorts的，狮身人面像，...

我做了所有these pip installs

但呼吁作出的文档目录的目录_make github.com/marble/typo3-docs-typo3-org资源给我以下

错误：

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!

所以模块t3SphinxThemeRtd没有找到，虽然我添加了pip命令！？

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

Answer 1

如上所述，您不需要在本地进行解析，即使它也可以让生活更轻松。

1. 使用斯芬克斯：如果你想要写第一个文件，看看基本的例子像https://github.com/georgringer/eventnews或https://github.com/sup7even/mailchimp/tree/master/Documentation

2. 单个的文件：但是，你甚至可以编写simplier文档。看看https://github.com/georgringer/page_speed/blob/master/README.rst这是一个单一的文件，然后呈现https://docs.typo3.org/typo3cms/extensions/page_speed/。

3. 降价：如果您对休息不太舒服，您可以请进入扩展目录，然后再进行渲染！

---

完整的文档写入文档可以在这里找到：https://docs.typo3.org/typo3cms/CoreApiReference/ExtensionArchitecture/Documentation/Index.html

Answer 2

您不需要设置Sphinx来编写文档。 文档是纯文本文件，所以没有什么可以阻止你。

虽然，当你想要测试文档时，Sphinx很有帮助。 我向Martin Bless报告了您的错误，他负责处理文档，他将尽快更新指南或尽快与您取得联系。

Answer 3

基督徒，你是完全正确的轨道上：是的，提供一些好的文档！越来越多的人真的这样做。所以我相信，2017年将是文档突破的一年。

一般来说这是最低要求：将文件./Documentation/Index.rst添加到您的扩展并在其中写入文档。使用reStructuredText作为标记。

快速入门：

为了更好地与更多的花里胡哨这个开始是你真的应该在此刻做什么：

• 让自己的T3DocumentationStarter项目之一是看起来像https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-000/。

• 阅读初学者的首页以了解其工作原理。在Github上https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-041/

• 直接编辑：

• 例如，这是一个为您保留。只需稍作更新并保存（=推送），几分钟后，您可以重新加载页面并查看服务器为您呈现的内容。你不必自己安装或渲染任何东西。服务器将为你做到这一点。

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

• 成为该项目的所有者发送邮件与您Github上的用户名到docteam到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以及