sphinx-typo3-theme 4.0.1

Sphinx TYPO3 theme for docs.typo3.org, starting 2015.

Project:

sphinx_typo3_theme

Team:

TYPO3 Documentation Team

Author:

Martin Bless <[e-mail]>

License:

MIT

Demo:

See this demo docs t3SphinxThemeRtdDemoDocs which are kind of a “stresstest” and demonstrate what’s possible and how the theme can be used.

Table of contents:

• Status

• Installation

  • Install the Theme Using PIP

  • Install directly using ‘setup.py’

• Usage

• Contributing or modifying the theme

  • Setup minimal development environment

• Usage on docs.typo3.org

Status

Installation

Install the Theme Using PIP

PIP is the Python packet manager for PyPi. ‘sphinx_typo3_theme’ is provided by the TYPO3 Documentation Team and available from PyPi.

Installation with pip:

# fetch from PyPi and install latest version:
pip install --upgrade sphinx-typo3-theme

# if required for your system, run a superuser:
pip install --upgrade sphinx-typo3-theme

For your interest: Some quick examples of pip usage:

# find help
pip install --help
pip --help

# install locally for this user only
pip install --upgrade --user sphinx-typo3-theme

# uninstall - no matter if installed by PIP or setup.py:
pip uninstall sphinx-typo3-theme

# search PyPi, the Python packet index
pip search sphinx-typo3-theme
pip search sphinx

Install directly using ‘setup.py’

To install directly from the package:

git clone [e-mail]:TYPO3-Documentation/sphinx_typo3_theme.git
cd sphinx_typo3_theme
(sudo) python setup.py install

# or install locally in user's home:
python setup.py install --user

Usage

To use the theme in your Sphinx project, you will need to add the following to your conf.py file:

import sphinx_typo3_theme

extensions = [
    ...
    "sphinx_typo3_theme",
]

html_theme = "sphinx_typo3_theme"

Contributing or modifying the theme

If you would like to help improve the, theme feel free to fork this project and create a pull request when you’re happy with your changes.

Setup minimal development environment

1. Install Node

2. Install Yarn:

   npm install yarn

3. Install project dependencies:

   yarn install

4. Compile:

   yarn build

5. Serve:

   yarn serve

Usage on docs.typo3.org

All static assets contained in this theme will be uploaded also to the TYPO3 CDN. The master branch as well as released are available on the CDN starting with version 4.0.1.

https://typo3.azureedge.net/typo3documentation/theme/<theme>/<branch|version>/css/theme.css
https://typo3.azureedge.net/typo3documentation/theme/sphinx_typo3_theme/master/css/theme.css
https://typo3.azureedge.net/typo3documentation/theme/sphinx_typo3_theme/4.0.1/css/theme.css