如何將文檔添加到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以及