a simple sphinx theme
Project description
# my simple sphinx theme
It has Japanese friendly font declaration and responsive stylings.
## Sample Page
http://hachibeedi.github.io/Sphinx-hachibee-theme/index.html
### ScreenShot
![shot](https://raw.github.com/hachibeeDI/Sphinx-hachibee-theme/master/example/screenshot.png)
## How to use?
```bash
pip install hachibee-sphinx-theme
```
change `conf.py` in your sphinx source directory
```python
# conf.py
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.pngmath',
'sphinx.ext.viewcode',
'hachibee_sphinx_theme',
]
html_theme = 'hachibee'
# Add any paths that contain custom themes here, relative to this directory.
import hachibee_sphinx_theme
html_theme_path = [hachibee_sphinx_theme.get_html_themes_path()]
```
## How to tweak the style?
If you dont like some styles(eg: font-size, font-family), You can add your own stylesheets.
First, you should add function `setup` in your local `conf.py`.
```python
# conf.py
def setup(app):
app.add_stylesheet('custom.css')
```
Second, create your stylesheet in `_static`.
Directory named `_static` is created on root directory in your sources.
```bash
echo "body {font-size: 1.5em}" > source/_static/custom.css
```
Lastly, you apply the alteration on your project.
```bash
make clean && make html
```
It has Japanese friendly font declaration and responsive stylings.
## Sample Page
http://hachibeedi.github.io/Sphinx-hachibee-theme/index.html
### ScreenShot
![shot](https://raw.github.com/hachibeeDI/Sphinx-hachibee-theme/master/example/screenshot.png)
## How to use?
```bash
pip install hachibee-sphinx-theme
```
change `conf.py` in your sphinx source directory
```python
# conf.py
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.pngmath',
'sphinx.ext.viewcode',
'hachibee_sphinx_theme',
]
html_theme = 'hachibee'
# Add any paths that contain custom themes here, relative to this directory.
import hachibee_sphinx_theme
html_theme_path = [hachibee_sphinx_theme.get_html_themes_path()]
```
## How to tweak the style?
If you dont like some styles(eg: font-size, font-family), You can add your own stylesheets.
First, you should add function `setup` in your local `conf.py`.
```python
# conf.py
def setup(app):
app.add_stylesheet('custom.css')
```
Second, create your stylesheet in `_static`.
Directory named `_static` is created on root directory in your sources.
```bash
echo "body {font-size: 1.5em}" > source/_static/custom.css
```
Lastly, you apply the alteration on your project.
```bash
make clean && make html
```
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
Close
Hashes for hachibee-sphinx-theme-0.1.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76c7679d4c7a2fd2dd57301e9790d5d3588e20986d1948e4fa93e43625ec4f84 |
|
MD5 | b1b609dafda5894e54f8b7d2d55eb299 |
|
BLAKE2b-256 | 6b970a734982794a3dfa32f1f335e0108be3fd07f09ca495bb767684bcabb1a5 |