Skip to content

Commit

Permalink
[TASK] Update documentation settings, resolves #6
Browse files Browse the repository at this point in the history
  • Loading branch information
fsuter committed May 12, 2020
1 parent 072347f commit 557a4d8
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 53 deletions.
1 change: 1 addition & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
2020-05-12 Francois Suter (Cobweb) <[email protected]>

* Ensure compatibility with TYPO3 10 LTS and updates to external_import and connector services, resolves #5
* Update documentation settings, resolves #6

2019-01-13 Francois Suter (Cobweb) <[email protected]>

Expand Down
26 changes: 26 additions & 0 deletions Documentation/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# EditorConfig is awesome: http://EditorConfig.org

# Use as master:
# https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/.editorconfig

# top-most EditorConfig file
root = true

[{*.rst,*.rst.txt}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 3
max_line_length = 80

# MD-Files
[*.md]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4
max_line_length = 80
47 changes: 33 additions & 14 deletions Documentation/Includes.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,40 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in THIS documentation project (= manual).

.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in this documentation project (= manual).
.. This files lives at
https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/Documentation/Includes.txt
Version: 2018-10-16

.. More information about this file:
https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#includes-txt

.. ==================================================
.. DEFINE SOME TEXT ROLES
.. --------------------------------------------------
.. Define some additional textroles
See: https://docs.typo3.org/typo3cms/HowToDocument/WritingReST/InlineCode.html

.. role:: typoscript(code)

.. role:: ts(typoscript)
:class: typoscript
.. ---------
.. textroles
.. ---------

.. role:: php(code)
.. role:: aspect (emphasis)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: rst(code)
.. role:: sep (strong)
.. role:: typoscript(code)

.. highlight:: php
.. role:: ts(typoscript)
:class: typoscript

.. role:: yaml(code)

.. default-role:: code

.. ---------
.. highlight
.. ---------

.. By default, code blocks are php

.. highlight:: php
2 changes: 1 addition & 1 deletion Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Every encouragement keeps the developer ticking, so don't hesitate
to send thanks or share your enthusiasm about the extension.

If you appreciate this work and want to show some support, please
check http://www.monpetitcoin.com/en/francois/support-me/.
check https://www.monpetitcoin.com/en/support-me/.
47 changes: 9 additions & 38 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
@@ -1,49 +1,20 @@
[general]
copyright = 2007-2019
copyright = 2007-2020
project = External Import Tutorial
release = 2.2.0
version = 2.2

[notify]
about_new_build = [email protected]

[html_theme_options]
github_branch =
github_commit_hash =
github_repository =
path_to_documentation_dir =
github_revision_msg =
github_sphinx_locale =
github_branch = master
github_repository = cobwebch
project_contact =
project_discussions =
project_home =
project_issues =
project_repository =
use_opensearch =
project_home = https://github.com/cobwebch/externalimport_tut
project_issues = https://github.com/cobwebch/externalimport_tut/issues
project_repository = https://github.com/cobwebch/externalimport_tut

[intersphinx_mapping]
extimp = http://docs.typo3.org/typo3cms/extensions/external_import/
t3tca = http://docs.typo3.org/typo3cms/TCAReference/

[extensions]
ext_00 = sphinx.ext.intersphinx
ext_01 = t3sphinx.ext.t3extras
ext_02 = t3sphinx.ext.t3tablerows
ext_03 = t3sphinx.ext.targets

[latex_elements]
papersize = a4paper
pointsize = 10pt
preamble = \usepackage{typo3}


# About Settings.cfg

# normal:
# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/TemplatesForCopying/ExampleFiles/Settings-minimal.cfg

# extensive:
# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/TemplatesForCopying/ExampleFiles/Settings-extensive.cfg

# Example files:
# https://github.com/marble/typo3-docs-typo3-org-resources/tree/master/TemplatesForCopying/ExampleFiles

# More:
# http://mbless.de/blog/2015/10/24/a-new-task-for-an-old-server.html#ini-files

0 comments on commit 557a4d8

Please sign in to comment.