Skip to content

Commit

Permalink
New theme for the web page.
Browse files Browse the repository at this point in the history
Design by Angel Soler (http://webylimonada.com), HTML and CSS
implementation by me.
  • Loading branch information
Fabian Pedregosa committed Sep 27, 2010
1 parent 6e982be commit 42fca0f
Show file tree
Hide file tree
Showing 11 changed files with 554 additions and 89 deletions.
10 changes: 5 additions & 5 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,31 +103,31 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'default'
html_theme = 'scikit-learn'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = ['themes']

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
html_short_title = 'scikits.learn'

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = 'logos/scikit-learn-logo-small.png'

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
html_favicon = 'logos/favicon.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
Binary file added doc/images/plot_digits_classification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 45 additions & 47 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,14 @@
.. raw:: html

<style type="text/css">
li.toctree-l1 {
padding: 0.5em 0 1em 0 ;
list-style-type: none;
font-size: 150% ;
}
li.toctree-l2 {
font-size: 70% ;
list-style-type: square;
}
li.toctree-l3 {
font-size: 85% ;
list-style-type: circle;
}
div.bodywrapper h1 {
text-align: center;
font-size: 300% ;
color: #000;
border: none;
background-color: #FFFFFF;
padding: 3px 0 0 0;
margin: 0 0 -16px 0;
}
</style>

===========================================
Scikits.learn: machine learning in Python
scikits.learn: machine learning in python
===========================================

.. |banner1| image:: auto_examples/cluster/images/plot_affinity_propagation.png
:height: 150
:target: auto_examples/cluster/plot_affinity_propagation.html


.. |banner2| image:: auto_examples/svm/images/plot_custom_kernel.png
.. |banner2| image:: auto_examples/glm/images/plot_lasso_lars.png
:height: 150
:target: auto_examples/svm/plot_custom_kernel.html

Expand Down Expand Up @@ -75,10 +45,22 @@ Scikits.learn: machine learning in Python
engineering**.



:Features:
* **Solid**: :ref:`supervised-learning`: classification, regression

* **Work in progress**: :ref:`unsupervised-learning`: :ref:`clustering`,
:ref:`gmm`, manifold learning, ICA

* **Planed**: Gaussian graphical models, matrix factorization

:License:
Open source, commercially usable: **BSD license** (3 clause)


.. raw:: html

<small>
<a href="auto_examples/plot_digits_classification.html"><img src="_images/plot_digits_classification.png" align="right" style="width: 400px"/></a>
<div class="example_digits">

:ref:`A simple Example: recognizing hand-written digits <example_plot_digits_classification.py>` ::

Expand All @@ -101,22 +83,15 @@ Scikits.learn: machine learning in Python
pl.subplot(2, 4, index+5)
pl.imshow(image, cmap=pl.cm.gray_r)
pl.title('Prediction: %i' % classifier.predict(image.ravel()))
.. raw:: html

</small>

.. image:: images/plot_digits_classification.png
:height: 140
:target: auto_examples/plot_digits_classification.html

:Features:
* **Solid**: :ref:`supervised-learning`: classification, regression

* **Work in progress**: :ref:`unsupervised-learning`: :ref:`clustering`,
:ref:`gmm`, manifold learning, ICA
.. raw:: html

* **Planed**: Gaussian graphical models, matrix factorization
</div>

:License:
Open source, commercially usable: **BSD license** (3 clause)

User guide
======================
Expand All @@ -131,16 +106,39 @@ User guide
:maxdepth: 3

install

Tutorial
========

.. toctree::
:maxdepth: 2

tutorial

Reference
=========

.. toctree::
:maxdepth: 2

supervised_learning
unsupervised_learning
model_selection
cross_validation
modules/classes

Gallery
=======

.. toctree::
:maxdepth: 2

auto_examples/index
modules/classes

Developement
============
.. toctree::
:maxdepth: 2

developers/index
performance
Binary file added doc/logos/favicon.ico
Binary file not shown.
Binary file added doc/logos/scikit-learn-logo-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion doc/modules/glm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ responses predicted by the linear approximation.
.. figure:: ../auto_examples/glm/images/plot_ols.png
:target: ../auto_examples/glm/plot_ols.html
:scale: 50%
:align: center

:class:`LinearRegression` will take in its `fit` method arrays X, y
and will store the coefficients :math:`w` of the linear model in its
Expand Down
24 changes: 24 additions & 0 deletions doc/support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
There are several ways to get in touch with the developers

Mailing List
============

Main mailing list is `scikit-learn-general
<https://lists.sourceforge.net/lists/listinfo/scikit-learn-general>`_. There
is also a commit list, where updates to the main repo get notified: `scikit-learn-commits <https://lists.sourceforge.net/lists/listinfo/scikit-learn-commits>`_



Bug tracker
===========

If you think you've encoutered a bug, please report it to the issue tracker:

http://sourceforge.net/apps/trac/scikit-learn/report/1

IRC
===
Some devs like to hang out on channel #learn on irc.freenode.net

If you do not have an irc client or are behind a firewall this web
client works fine: http://webchat.freenode.net
36 changes: 0 additions & 36 deletions doc/templates/layout.html

This file was deleted.

108 changes: 108 additions & 0 deletions doc/themes/scikit-learn/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{#
scikit-learn/layout.html
~~~~~~~~~~~~~~~~~

Layout for scikit-learn, after a design made by Angel Soler
(http://webylimonada.org)

:copyright: Fabian Pedregosa
:license: BSD
#}
{% extends "basic/layout.html" %}

{% block header %}
<div class="header-wrapper">
<div class="header">
{%- if logo %}
<p class="logo"><a href="{{ pathto(master_doc) }}">
<img src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
</a>
</p>
{%- endif %}



{%- block navbar -%}
<div class="navbar">
<ul>
<li><a href="http://sourceforge.net/projects/scikit-learn/files/">download</a></li>
<li><a href="{{pathto('support')}}">support</a></li>
<li><a href="{{pathto('modules/classes')}}">reference</a></li>
<li><a href="{{pathto('auto_examples/index')}}">gallery</a></li>
<li><a href="{{pathto('developers/index')}}">development</a></li>
</ul>

<form class="search" action="{{ pathto('search') }}" method="get">
<input id="search_input"
type="text" name="q" size="18" value=" search..."
onfocus="if(this.value==this.defaultValue)this.value='';this.style.color='black'"
onblur="if(this.value=='') { this.value=this.defaultValue;this.style.color='#cccccc'}"/>
<input type="submit" value="{{ _('Go') }}" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div> <!-- end navbar -->
{%- endblock -%}


</div>
</div>
{% endblock %}

{% block content %}
<div class="content-wrapper">

<!-- <div id="blue_tile"></div> -->

<div class="sphinxsidebar">

{%- if pagename != 'index' %}
<div class="rel">
{%- for rellink in rellinks|reverse %}
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.last %}{{ reldelim2 }}{% endif %}
{%- endfor %}
</div>
{% endif %}

<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
{{ toc }}

</div>

<div class="content">
{%- block document %}
{{ super() }}
{%- endblock %}
<div class="clearer"></div>
</div>
</div>
{% endblock %}

{% block footer %}
<div class="footer-wrapper">
<div class="footer">
<div class="left">
{%- for rellink in rellinks|reverse %}
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
{%- if not loop.last %}{{ reldelim2 }}{% endif %}
{%- endfor %}
{%- if show_source and has_source and sourcename %}
<br/>
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
rel="nofollow">{{ _('Show Source') }}</a>
{%- endif %}
</div>

<div class="right">
{{ super() }}
</div>
<div class="clearer"></div>
</div>
</div>
{% endblock %}

{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
Loading

0 comments on commit 42fca0f

Please sign in to comment.