Skip to content
Snippets Groups Projects
Commit 99d08b57 authored by Joel Nothman's avatar Joel Nothman
Browse files

DOC organise documentation hierarchy / table of contents

parent dc8578ae
Branches
Tags
No related merge requests found
...@@ -170,7 +170,7 @@ html_static_path = ['images'] ...@@ -170,7 +170,7 @@ html_static_path = ['images']
#html_additional_pages = {} #html_additional_pages = {}
# If false, no module index is generated. # If false, no module index is generated.
html_use_modindex = False html_domain_indices = False
# If false, no index is generated. # If false, no index is generated.
html_use_index = False html_use_index = False
...@@ -225,7 +225,7 @@ latex_preamble = r""" ...@@ -225,7 +225,7 @@ latex_preamble = r"""
#latex_appendices = [] #latex_appendices = []
# If false, no module index is generated. # If false, no module index is generated.
#latex_use_modindex = True latex_domain_indices = False
trim_doctests_flags = True trim_doctests_flags = True
......
This diff is collapsed.
This diff is collapsed.
...@@ -30,15 +30,15 @@ Documentation of scikit-learn 0.17.dev0 ...@@ -30,15 +30,15 @@ Documentation of scikit-learn 0.17.dev0
<ul> <ul>
<li>scikit-learn 0.17 (development)</li> <li>scikit-learn 0.17 (development)</li>
<li><a href="http://scikit-learn.org/stable/documentation.html">scikit-learn 0.16 (stable)</a></li> <li><a href="http://scikit-learn.org/stable/documentation.html">scikit-learn 0.16 (stable)</a></li>
<li><a href="http://scikit-learn.org/0.15/documentation.html">scikit-learn 0.14</a></li> <li><a href="http://scikit-learn.org/0.15/documentation.html">scikit-learn 0.15</a></li>
<li><a href="http://scikit-learn.org/0.14/documentation.html">scikit-learn 0.14</a></li> <li><a href="http://scikit-learn.org/0.14/documentation.html">scikit-learn 0.14</a></li>
<li><a href="http://scikit-learn.org/0.13/user_guide.html">scikit-learn 0.13</a></li> <li><a href="http://scikit-learn.org/0.13/user_guide.html">scikit-learn 0.13</a></li>
<li><a href="http://scikit-learn.org/0.12/user_guide.html">scikit-learn 0.12</a></li>
<li id="other-versions">Older versions <li id="other-versions">Older versions
<a class="btn dropdown-toggle" data-toggle="dropdown"> <a class="btn dropdown-toggle" data-toggle="dropdown">
<span class="caret"></span> <span class="caret"></span>
</a> </a>
<ul class="dropdown-menu"> <ul class="dropdown-menu">
<li><a href="http://scikit-learn.org/0.12/user_guide.html">scikit-learn 0.12</a></li>
<li><a href="http://scikit-learn.org/0.11/user_guide.html">scikit-learn 0.11</a></li> <li><a href="http://scikit-learn.org/0.11/user_guide.html">scikit-learn 0.11</a></li>
<li><a href="http://scikit-learn.org/0.10/user_guide.html">scikit-learn 0.10</a></li> <li><a href="http://scikit-learn.org/0.10/user_guide.html">scikit-learn 0.10</a></li>
<li><a href="http://scikit-learn.org/0.9/user_guide.html">scikit-learn 0.9</a></li> <li><a href="http://scikit-learn.org/0.9/user_guide.html">scikit-learn 0.9</a></li>
......
.. We want the previous/next button to work on the user guide pages and on the
API. We have to put the doctree so that sphinx populates the
rellinks. Yet, we don't want it to be displayed on the main page, hence we
don't display through the css.
.. raw:: html
<div class="no-display">
.. toctree::
tutorial/index
user_guide
auto_examples/index
faq
support
whats_new
presentations
about
documentation
datasets/index
datasets/covtype
datasets/labeled_faces
datasets/mldata
datasets/olivetti_faces
datasets/twenty_newsgroups
modules/classes
testimonials/testimonials
developers/index
developers/debugging
developers/maintainer
developers/performance
developers/utilities
install
tutorial/basic/tutorial
tutorial/machine_learning_map/index
.. raw:: html
</div>
.. This is were the real work starts.
.. raw:: html .. raw:: html
<!-- Block section --> <!-- Block section -->
...@@ -386,3 +339,16 @@ ...@@ -386,3 +339,16 @@
<script> <script>
$('#testimonials_carousel').carousel() $('#testimonials_carousel').carousel()
</script> </script>
.. Define an order for the Table of Contents:
.. toctree::
:maxdepth: 2
:hidden:
preface
tutorial/index
user_guide
auto_examples/index
modules/classes
developers/index
========= =============
Reference API Reference
========= =============
This is the class and function reference of scikit-learn. Please refer to This is the class and function reference of scikit-learn. Please refer to
the :ref:`full user guide <user_guide>` for further details, as the class and the :ref:`full user guide <user_guide>` for further details, as the class and
......
.. This helps define the TOC ordering for "about us" sections. Particularly
useful for PDF output as this section is not linked from elsewhere.
.. _preface_menu:
.. include:: ../includes/big_toc_css.rst
.. include:: ../tune_toc.rst
.. top level heading needed for LaTeX TOC in sphinx<=1.3.1
************
scikit-learn
************
=======================
Welcome to scikit-learn
=======================
|
.. toctree::
:maxdepth: 2
install
faq
support
related_projects
about
testimonials/testimonials
whats_new
|
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. include:: ../includes/big_toc_css.rst .. include:: ../includes/big_toc_css.rst
.. include:: ../tune_toc.rst
====================== ======================
scikit-learn Tutorials scikit-learn Tutorials
...@@ -14,18 +15,10 @@ scikit-learn Tutorials ...@@ -14,18 +15,10 @@ scikit-learn Tutorials
:maxdepth: 2 :maxdepth: 2
basic/tutorial.rst basic/tutorial.rst
.. toctree::
:maxdepth: 2
statistical_inference/index.rst statistical_inference/index.rst
.. toctree::
:maxdepth: 2
text_analytics/working_with_text_data.rst text_analytics/working_with_text_data.rst
machine_learning_map/index
../presentations
| |
......
.. title:: User guide: contents .. title:: User guide: contents
..
We are putting the title as a raw HTML so that it doesn't appear in
the contents
.. _user_guide: .. _user_guide:
==========
User Guide
==========
.. include:: includes/big_toc_css.rst .. include:: includes/big_toc_css.rst
.. nice layout in the toc .. nice layout in the toc
......
...@@ -2,6 +2,9 @@ ...@@ -2,6 +2,9 @@
.. _changes_0_17: .. _changes_0_17:
===============
Release history
===============
0.17 0.17
==== ====
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment