Skip to content

Commit cb984f8

Browse files
authored
add base for user guide (#399)
* add base for user guide * [quick doc] [skip tests] missing == * [doc quick] [skip tests] =
1 parent c21334e commit cb984f8

File tree

7 files changed

+53
-0
lines changed

7 files changed

+53
-0
lines changed

docs/src/concepts.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _concepts:
2+
3+
4+
======================
5+
Definition of concepts
6+
======================

docs/src/grouping.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _grouping:
2+
3+
4+
==========================================
5+
Measuring the importance of feature groups
6+
==========================================

docs/src/high_dimension.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _high_dimension:
2+
3+
4+
===========================
5+
Inference in high dimension
6+
===========================

docs/src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,5 +181,6 @@ References
181181
:maxdepth: 1
182182

183183
api
184+
user_guide
184185
generated/gallery/examples/index
185186
dev/index

docs/src/methods_list.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _methods_list:
2+
3+
4+
===============
5+
List of methods
6+
===============

docs/src/user_guide.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _user_guide:
2+
3+
==========
4+
User guide
5+
==========
6+
7+
8+
TODO: define the target audience of the user guide.
9+
10+
Table of contents
11+
=================
12+
13+
.. toctree::
14+
:numbered:
15+
:maxdepth: 3
16+
17+
concepts.rst
18+
methods_list.rst
19+
visualization.rst
20+
grouping.rst
21+
high_dimension.rst
22+

docs/src/visualization.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _visualization:
2+
3+
4+
=======================
5+
Tools for visualization
6+
=======================

0 commit comments

Comments
 (0)