Skip to content
This repository has been archived by the owner on Feb 25, 2023. It is now read-only.

Commit

Permalink
[TASK] Update to new configuration
Browse files Browse the repository at this point in the history
Also changed version from 1.0.0 to 6.2 (let's match Core versions).
  • Loading branch information
Francois Suter committed Apr 22, 2016
1 parent 8cc81a5 commit 005a26c
Show file tree
Hide file tree
Showing 11 changed files with 550 additions and 604 deletions.
20 changes: 10 additions & 10 deletions Documentation/Includes.txt
@@ -1,14 +1,14 @@

.. 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).

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

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

.. role:: php(code)

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

.. default-role:: code
.. highlight:: php
10 changes: 3 additions & 7 deletions Documentation/Index.rst
@@ -1,7 +1,3 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: Includes.txt

Expand All @@ -16,19 +12,19 @@ Templating Tutorial: Basics
doc_tut_templating

:Version:
1.0.0
6.2

:Language:
en

:Description:
Step-by-step to templating in TYPO3 using TypoScript.
Step-by-step guide to templating in TYPO3 using TypoScript.

:Keywords:
template, typoscript, beginner

:Copyright:
2011-2015
2011-2016

:Author:
Documentation Team
Expand Down
66 changes: 66 additions & 0 deletions Documentation/Settings.cfg
@@ -0,0 +1,66 @@
# 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 =


[general]

; endless list of all of the general simple settings
; you can use in 'conf.py'

project = Templating Tutorial: Basics
version = 6.2
release = 6.2
t3author = Documentation Team
copyright = since 2011 by the TYPO3 Documentation Team
description = A tutorial about setting up a full web site template with TypoScript


[html_theme_options]

; for theme t3SphinxThemeRtd

github_branch = latest
github_commit_hash =
github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-Templating
github_revision_msg =
github_sphinx_locale =
project_contact = mailto:documentation@typo3.org
project_discussions =
project_home =
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Templating/issues
project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Templating
use_opensearch =


[intersphinx_mapping]

; in this manual we actually use:

t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference
t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference
t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial
t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial


# [extensions]

# sphinxExtTodo = sphinx.ext.todo


# For a reference about this file see:
# https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/userroot/scripts/bin/conf-2015-10.Reference.Settings.cfg
35 changes: 0 additions & 35 deletions Documentation/Settings.yml

This file was deleted.

17 changes: 6 additions & 11 deletions Documentation/Targets.rst
@@ -1,16 +1,11 @@
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: Includes.txt

.. _labels-for-crossreferencing:

.. only:: t3html
.. only:: html

Index: Labels for Cross-Referencing
===================================
.. _Targets-for-Cross-Referencing:

.. ref-targets-list::
Targets for Cross-Referencing
=============================

.. ref-targets-list::
44 changes: 44 additions & 0 deletions Documentation/_make/Overrides.cfg
@@ -0,0 +1,44 @@
# coding: utf-8

# #####
#
# Overrides.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 =


[general]

; endless list of all of the general simple settings
; you can use in 'conf.py'



[html_theme_options]

; for theme t3SphinxThemeRtd

;IMPORTANT!
; Rendering for docs.typo3.org?

; Yes!
# docstypo3org = yes
; No!
docstypo3org =

show_copyright = yes
show_last_updated = yes
show_revision = yes
show_sourcelink = yes
show_sphinx = yes
use_opensearch =
41 changes: 41 additions & 0 deletions Documentation/_make/README.rst
@@ -0,0 +1,41 @@

README.rst
==========

:author: mb
:date: 2015-10-26

This folder ``_make`` is provided as a service for convenience.
It helps to render this documentation on your own machine
"at home".

It is a good idea to check whether the *conf.py* file in this
*\_make* folder is still up to date. The latest version should
be maintained here:
https://github.com/marble/typo3-docs-typo3-org-resources/blob/master/userroot/scripts/bin/conf-2015-10.py



Steps:
------

1. Prepare your machine

Follow the installation steps of
http://mbless.de/blog/2015/01/26/sphinx-doc-installation-steps.html


2. On the commandline::

cd path/to/_make
make
make html


3. Open ``_make/build/html/Index.html`` in the browser.


4. Check ``_make/_not_versioned/`` for logfiles.


Enjoy!
10 changes: 10 additions & 0 deletions Documentation/_make/buildsettings.sh
@@ -0,0 +1,10 @@
# buildsettings.sh

# absolute path, or relative to conf.py, without suffix (.rst)
MASTERDOC=../Index

# absolute path, or relative to conf.py
BUILDDIR=./build

# absolute path, or relative to conf.py
LOGDIR=./_not_versioned

0 comments on commit 005a26c

Please sign in to comment.