Sphinx extension to compile sass to css in running sphinx-build.
Project Links
Meta
Author: Kazuya Takei
Classifiers
Development Status
- 4 - Beta
Framework
- Sphinx
- Sphinx :: Extension
Intended Audience
- Developers
License
- OSI Approved :: Apache Software License
Programming Language
- Python :: 3.7
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
Topic
- Documentation :: Sphinx
Overview
Sphinx extension to compile sass to css in running sphinx-build.
Install
pip install sphinxcontrib-sassUsage
Install from source
Edit conf.py
Set sphinxcontrib.sass into extensions
Configure for sphinxcontrib.sass (see example)
Run sphinx-build
Options
- sass_src_dir
Root directory of SASS source files.
- sass_out_dir
Root directory to output compiled css files.
- sass_targets
File map of sources and outputs
- sass_output_style
Output style to generate css by libsass.
- sass_include_paths
Include path configuration for libsass.
Example
extensions = [
"sphinxcontrib.sass",
]
html_css_files = ["css/custom.css"]
sass_src_dir = "_sass"
sass_out_dir = "_static/css"
sass_targets = {
"custom.scss": "custom.css"
}License
Apache 2.0. See it.
