Sphinx TYPO3 theme for docs.typo3.org, starting 2015.
Project description
- Project:
sphinx_typo3_theme
- Team:
TYPO3 Documentation Team
- 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
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 git@github.com: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 and add sphinx_typo3_theme to your requirements.txt
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
Install Node
Install Yarn:
npm install yarn
Install project dependencies:
yarn install
Compile:
yarn build
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_typo3_theme-4.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f94dc1706316ceffb3bbe819009bb766c50160e9b30d3d2c02bac83d9564aee7 |
|
MD5 | 540e7cc486e4149328b63671d1caf33f |
|
BLAKE2b-256 | 4e3f2dd006bd7df37afb958877bfc6739125d9504df1f6bc387e5b952b2d3e07 |