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:
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 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
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.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 571ff5f4ec65e6b12e7a8c41e5747c92a6c7d06ed0e09a75dc5082022359d288 |
|
MD5 | 314e6ce75f9206b25e9ae234266a67ba |
|
BLAKE2b-256 | f76fec372292bb6a137386b2789587f0b9a23a84451345f84e88b733dcb3deab |