-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Align with new TYPO3 documentation standards (#192)
* [TASK] Align with new TYPO3 documentation standards - align README.rst, Settings.cfg, Index.rst, Includes.rst.txt, genindex.rst, Sitemap.rst - remove outdated Targets.rst See TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument@c2bb63b for further details. * [DOCS] Reference manual's start page with :doc:`<manual>:Index` Adding the custom label `start` to the beginning of the manual's Index.rst is redundant. Use :doc:`<manual>:Index` instead of :ref:`<manual:start>` to refer to it. * [DOCS] Fix rendering warnings * [DOCS] Apply new intersphinx mapping names
- Loading branch information
1 parent
de2b98c
commit 050d6ed
Showing
12 changed files
with
137 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,34 @@ | ||
.. This is 'Includes.rst.txt'. It is included at the very top of each and | ||
every ReST source file in THIS documentation project (= manual). | ||
.. More information about this file: | ||
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt | ||
.. role:: aspect (emphasis) | ||
.. ---------- | ||
.. text roles | ||
.. ---------- | ||
.. role:: aspect(emphasis) | ||
.. role:: bash(code) | ||
.. role:: html(code) | ||
.. role:: js(code) | ||
.. role:: php(code) | ||
.. role:: typoscript(code) | ||
.. role:: shell(code) | ||
:class: shell | ||
.. role:: rst(code) | ||
.. role:: sep(strong) | ||
.. role:: sql(code) | ||
|
||
.. role:: ts(typoscript) | ||
.. role:: tsconfig(code) | ||
:class: typoscript | ||
|
||
.. role:: typoscript(code) | ||
.. role:: xml(code) | ||
:class: html | ||
|
||
.. role:: yaml(code) | ||
|
||
.. default-role:: code | ||
|
||
.. --------- | ||
.. highlight | ||
.. --------- | ||
.. By default, code blocks use PHP syntax highlighting | ||
.. highlight:: php |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,62 @@ | ||
# coding: utf-8 | ||
|
||
# ##### | ||
# | ||
# Settings.cfg - A TYPO3 Documentation Project's Configuration File | ||
# | ||
# About Syntax: | ||
# See https://docs.python.org/2/library/configparser.html | ||
# | ||
# Put comments in separate lines! | ||
# | ||
# ##### | ||
|
||
|
||
# Attention: | ||
# LEAVE RIGHT SIDE EMPTY for a 'false' value like: | ||
# example_of_false_value = | ||
|
||
# More information about this file: | ||
# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg | ||
|
||
[general] | ||
|
||
; endless list of all of the general simple settings | ||
; you can use in 'conf.py' | ||
|
||
project = Getting Started | ||
version = main (development) | ||
release = main (development) | ||
t3author = Documentation Team | ||
copyright = since 2004 by the TYPO3 Documentation Team | ||
description = A Tutorial to get started with TYPO3 | ||
|
||
copyright = since 2012 by the TYPO3 contributors | ||
|
||
[html_theme_options] | ||
|
||
# for "Edit me on GitHub | ||
|
||
github_branch = main | ||
# "Edit on GitHub" button | ||
github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted | ||
github_branch = main | ||
|
||
|
||
project_contact = https://typo3.org/community/teams/documentation/#c9886 | ||
project_discussions = | ||
project_home = | ||
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues | ||
# Footer links | ||
project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ | ||
project_contact = https://typo3.slack.com/archives/C028JEPJL | ||
project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted | ||
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues | ||
project_discussions = | ||
|
||
[intersphinx_mapping] | ||
|
||
; in this manual we actually use: | ||
|
||
h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ | ||
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ | ||
t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ | ||
t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ | ||
workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ | ||
|
||
[extensions] | ||
use_opensearch = | ||
|
||
; embed YouTube videos | ||
any_name_youtube = sphinxcontrib.youtube | ||
[intersphinx_mapping] | ||
|
||
# Official TYPO3 manuals | ||
# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ | ||
# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ | ||
# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ | ||
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ | ||
# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ | ||
t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ | ||
# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ | ||
# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ | ||
# t3home = https://docs.typo3.org/ | ||
# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ | ||
# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ | ||
t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ | ||
# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ | ||
# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ | ||
# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/ | ||
# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ | ||
# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ | ||
# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ | ||
# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ | ||
# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ | ||
# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ | ||
|
||
# TYPO3 system extensions | ||
# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ | ||
# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ | ||
# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ | ||
# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ | ||
# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ | ||
# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ | ||
# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ | ||
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ | ||
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ | ||
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ | ||
ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
:template: sitemap.html | ||
|
||
.. _sitemap: | ||
.. include:: /Includes.rst.txt | ||
|
||
======= | ||
Sitemap | ||
======= | ||
|
||
.. template 'sitemap.html' will insert the toctree as a sitemap here below normal contents | ||
.. The sitemap.html template will insert here the page tree automatically. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.