a simple sphinx theme
Project description
=========================================================
Sphinx hachibee theme
=========================================================
Sample Page of HEAD revision
=============================================
http://hachibeedi.github.io/Sphinx-hachibee-theme/index.html
Characteristic
=================================================================
- Simple and clean color combinations.
- Japanese friendly font declaration.
- Responsive stylings.
ScreenShot
------------------------------------------------------------
.. image :: https://raw.github.com/hachibeeDI/Sphinx-hachibee-theme/master/example/screenshot.png
Installation
=================================================================
.. code-block:: bash
pip install hachibee-sphinx-theme
How to use
=============================================
change `conf.py` in your sphinx source directory
.. code-block:: python
# conf.py
extensions = [
# ... ...
'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 don't like some styles(eg: font-size, font-family), You can add your own stylesheets.
First, you should add function `setup` is in your local `conf.py`.
.. code-block:: python
# conf.py
def setup(app):
app.add_stylesheet('custom.css')
Second, create your stylesheet in `_static`.
Directory named `_static` is created on the root directory in your sources.
This is sample to remove button to back top is as below.
.. code-block:: bash
echo "#raise-top {display: none; }" > source/_static/custom.css
Lastly, you apply the alteration to your project.
.. code-block:: bash
make clean && make html
LICENCE
=================================================================
MIT
Sphinx hachibee theme
=========================================================
Sample Page of HEAD revision
=============================================
http://hachibeedi.github.io/Sphinx-hachibee-theme/index.html
Characteristic
=================================================================
- Simple and clean color combinations.
- Japanese friendly font declaration.
- Responsive stylings.
ScreenShot
------------------------------------------------------------
.. image :: https://raw.github.com/hachibeeDI/Sphinx-hachibee-theme/master/example/screenshot.png
Installation
=================================================================
.. code-block:: bash
pip install hachibee-sphinx-theme
How to use
=============================================
change `conf.py` in your sphinx source directory
.. code-block:: python
# conf.py
extensions = [
# ... ...
'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 don't like some styles(eg: font-size, font-family), You can add your own stylesheets.
First, you should add function `setup` is in your local `conf.py`.
.. code-block:: python
# conf.py
def setup(app):
app.add_stylesheet('custom.css')
Second, create your stylesheet in `_static`.
Directory named `_static` is created on the root directory in your sources.
This is sample to remove button to back top is as below.
.. code-block:: bash
echo "#raise-top {display: none; }" > source/_static/custom.css
Lastly, you apply the alteration to your project.
.. code-block:: bash
make clean && make html
LICENCE
=================================================================
MIT
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.2.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 639541658dfd8cd69ea9d649caba9ad47aa0e5fb53ea22fa5a09d45ee2406a96 |
|
MD5 | dd19513ae4374b210c29100c59ff06b9 |
|
BLAKE2b-256 | 0d1f4ebf66e845ccac08d39f5d4a6b966c0382109c84d77c0b5a29bf9520fdd6 |