Index of /besson/publis/f6_sphinx_theme

	Name	Last modified	Size	Description
	Parent Directory		-	Root of the website (in English or in French)
	static/	2016-02-04 14:13	-
	screenshots/	2016-02-05 20:55	-
	theme.conf	2016-02-04 14:03	47
	layout.html	2016-02-04 14:08	1.1K
	README.md	2016-06-27 21:41	1.9K	Some details about this page
	LICENSE	2016-01-31 22:36	34K

# *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?
> [GPL License](http://www.gnu.org/licenses/gpl.html).

[![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/)