Skip to content

Commit 8ef4cda

Browse files
committed
[TASK] Update documentation settings, resolves #7
1 parent cbed70b commit 8ef4cda

File tree

6 files changed

+88
-55
lines changed

6 files changed

+88
-55
lines changed

ChangeLog

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
2020-04-12 Francois Suter (Idéative) <typo3@ideative.ch>
2+
3+
* Update documentation settings, resolves #7
4+
15
2020-04-10 Francois Suter (Idéative) <typo3@ideative.ch>
26

37
* Ensure compatibility with TYPO3 10

Documentation/.editorconfig

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# Use as master:
4+
# https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/blob/master/.editorconfig
5+
6+
# top-most EditorConfig file
7+
root = true
8+
9+
[{*.rst,*.rst.txt}]
10+
charset = utf-8
11+
end_of_line = lf
12+
insert_final_newline = true
13+
trim_trailing_whitespace = true
14+
indent_style = space
15+
indent_size = 3
16+
max_line_length = 80
17+
18+
# MD-Files
19+
[*.md]
20+
charset = utf-8
21+
end_of_line = lf
22+
insert_final_newline = true
23+
trim_trailing_whitespace = true
24+
indent_style = space
25+
indent_size = 4
26+
max_line_length = 80

Documentation/.gitignore

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
1-
#########################
2-
# Git
3-
# global ignore file
4-
########################
5-
# ignoring temporary files (left by e.g. vim)
6-
# ignoring by common IDE's used directories/files
7-
# dont ignore .rej and .orig as we want to see/clean files after conflict resolution
8-
#
1+
# Git global ignore file
92
# for local exclude patterns please edit .git/info/exclude
10-
#
3+
# Example file see https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.gitignore
4+
5+
# ignore generated documentation
6+
*GENERATED*
7+
8+
# ignore typical clutter of IDEs and editors (this could be added in .git/info/exclude,
9+
# but we add it here for convenience)
1110
*~
1211
*.bak
1312
*.idea
1413
*.project
1514
*.swp
16-
.buildpath
17-
.cache
1815
.project
19-
.session
20-
.settings
21-
.TemporaryItems
2216
.webprj
23-
nbproject
17+
nbproject

Documentation/Includes.txt

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,40 @@
1-
.. ==================================================
2-
.. FOR YOUR INFORMATION
3-
.. --------------------------------------------------
4-
.. -*- coding: utf-8 -*- with BOM.
1+
.. This is 'Includes.txt'. It is included at the very top of each and
2+
every ReST source file in THIS documentation project (= manual).
53

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

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

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

14-
.. role:: typoscript(code)
1514

16-
.. role:: ts(typoscript)
17-
:class: typoscript
15+
.. ---------
16+
.. textroles
17+
.. ---------
1818

19-
.. role:: php(code)
19+
.. role:: aspect (emphasis)
20+
.. role:: html(code)
21+
.. role:: js(code)
22+
.. role:: php(code)
23+
.. role:: rst(code)
24+
.. role:: sep (strong)
25+
.. role:: typoscript(code)
2026

21-
.. highlight:: php
27+
.. role:: ts(typoscript)
28+
:class: typoscript
29+
30+
.. role:: yaml(code)
31+
32+
.. default-role:: code
33+
34+
.. ---------
35+
.. highlight
36+
.. ---------
37+
38+
.. By default, code blocks are php
39+
40+
.. highlight:: php

Documentation/Settings.cfg

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[general]
2+
copyright = 2009-2020
3+
project = JSON Connector Service
4+
release = 2.2.0
5+
6+
[html_theme_options]
7+
github_branch = master
8+
github_repository = cobwebch/svconnector_sql
9+
project_contact =
10+
project_discussions =
11+
project_home = https://github.com/cobwebch/svconnector_sql/
12+
project_issues = https://github.com/cobwebch/svconnector_sql/issues/
13+
project_repository = https://github.com/cobwebch/svconnector_sql/
14+
15+
[intersphinx_mapping]
16+
svconnector = http://docs.typo3.org/typo3cms/extensions/svconnector/

Documentation/Settings.yml

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)