https://github.com/naereen/f6_sphinx_theme

Bright theme for sphinx-doc :snake: :white_medium_square: (based on f6 by @vimalkvn)
https://github.com/naereen/f6_sphinx_theme

python-2 python-3 sphinx-doc sphinx-documentation sphinx-theme

Last synced: 4 months ago
JSON representation

Bright theme for sphinx-doc :snake: :white_medium_square: (based on f6 by @vimalkvn)

• Host: GitHub
• URL: https://github.com/naereen/f6_sphinx_theme
• Owner: Naereen
• License: gpl-3.0
• Created: 2016-02-04T13:32:45.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-28T11:50:45.000Z (almost 9 years ago)
• Last Synced: 2025-06-13T10:05:14.740Z (4 months ago)
• Topics: python-2, python-3, sphinx-doc, sphinx-documentation, sphinx-theme
• Language: CSS
• Homepage: http://vimalkumarvelayudhan.com/sphinx-themes/f6/html/index.html
• Size: 920 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# *F6 theme* for [Sphinx](http://sphinx-doc.org/)

> A clean and minimalist theme for [Sphinx doc](http://sphinx-doc.org/).

> Mostly white -> ``#ffffff`` -> **f6**.

----

## How to use it?

### Installation

Clone the repository, copy the files [theme.conf](theme.conf), [layout.html](./layout.html)

(and the [static](./static) folder),

to a folder ``_themes/f6/`` located in your Sphinx project:

    $ git clone https://github.com/Naereen/f6_sphinx_theme/

    $ cd f6_sphinx_theme/

    $ cp * /path/to/your/project/

### Usage

Change your [conf.py](http://sphinx-doc.org/config.html#options-for-html-output) sphinx file to:

    html_theme = 'f6'

    html_theme_path = '/location/to/the/files/f6/'

1. Change the ``html_theme`` parameter to ``f6``.

2. Change the ``html_theme_path`` to the location containing the f6 files.

----

## Examples

### [Screenshots](./screenshots)

![F6 Sphinx theme screenshot 1](./screenshots/demo_f6_sphinx_theme_1.png)

![F6 Sphinx theme screenshot 2](./screenshots/demo_f6_sphinx_theme_2.png)

![F6 Sphinx theme screenshot 3](./screenshots/demo_f6_sphinx_theme_3.png)

### Live demos?

- [Vimalkumar's demo](http://vimalkumarvelayudhan.com/sphinx-themes/f6/html/index.html),

- [folium documentation](https://folium.readthedocs.org/en/latest/),

- [pi-qmc documentation](http://pi-qmc.readthedocs.org/).

----

## About

### Authors?

- [Forked by](https://github.com/Naereen/f6_sphinx_theme/) [Lilian Besson (Naereen)](https://github.com/Naereen/),

- Original author: [Vimalkumar Velayudhan (vimalkvn)](https://github.com/vimalkvn), copied from [GitHub](https://github.com/vimalkvn/sphinx-themes/tree/master/f6). See [here for more themes](http://vimalkumarvelayudhan.com/sphinx-themes/). Modified from the default Sphinx theme.

### :scroll: License ? [![GitHub license](https://img.shields.io/github/license/Naereen/f6_sphinx_theme.svg)](https://github.com/Naereen/f6_sphinx_theme/blob/master/LICENSE)

This plug-in is published under the terms of the [GPL License](http://www.gnu.org/licenses/gpl.html) (file [LICENSE](LICENSE)),

© [Lilian Besson](https://GitHub.com/Naereen), 2016.

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/f6_sphinx_theme/graphs/commit-activity)

[![Ask Me Anything !](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg)](https://GitHub.com/Naereen/ama)

[![Analytics](https://ga-beacon.appspot.com/UA-38514290-17/github.com/Naereen/f6_sphinx_theme/README.md?pixel)](https://GitHub.com/Naereen/f6_sphinx_theme/)

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)

[![ForTheBadge uses-badges](http://ForTheBadge.com/images/badges/uses-badges.svg)](http://ForTheBadge.com)

[![ForTheBadge uses-git](http://ForTheBadge.com/images/badges/uses-git.svg)](https://GitHub.com/)

[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://GitHub.com/Naereen/)