Skip to content

Commit ea6d5e8

Browse files
committed
add: new sphinx version, resolution paramter update and reordered table of contents
1 parent 6ca7c75 commit ea6d5e8

File tree

4 files changed

+318
-253
lines changed

4 files changed

+318
-253
lines changed

doc/source/community_detection_guide.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Welcome to the Community Detection Guide!
1+
Community Detection Guide
22
=========================================
33

44
This documentation provides an overview of the notebooks available in the community detection guide.
@@ -7,17 +7,17 @@ This documentation provides an overview of the notebooks available in the commun
77
:maxdepth: 2
88
:hidden:
99

10-
community_detection_guide/notebooks/functions.ipynb
11-
community_detection_guide/notebooks/community_detection_algorithms.ipynb
1210
community_detection_guide/notebooks/initial_workflow.ipynb
13-
community_detection_guide/notebooks/consensus_clustering.ipynb
11+
community_detection_guide/notebooks/community_detection_algorithms.ipynb
12+
community_detection_guide/notebooks/test_significance_of_community.ipynb
1413
community_detection_guide/notebooks/generating_and_visualizing_clusters.ipynb
1514
community_detection_guide/notebooks/hierarchical_clustering.ipynb
15+
community_detection_guide/notebooks/modularity.ipynb
1616
community_detection_guide/notebooks/interactive_resolution_on_sierpinski.ipynb
17+
community_detection_guide/notebooks/consensus_clustering.ipynb
1718
community_detection_guide/notebooks/membership_vector.ipynb
18-
community_detection_guide/notebooks/modularity.ipynb
19-
community_detection_guide/notebooks/test_significance_of_community.ipynb
2019
community_detection_guide/notebooks/working_with_clusterings.ipynb
20+
community_detection_guide/notebooks/functions.ipynb
2121

2222
.. grid:: 2 2 3 3
2323
:gutter: 3
@@ -28,7 +28,7 @@ This documentation provides an overview of the notebooks available in the commun
2828
:class-card: sd-card-hover card-red-orange
2929
:shadow: sm
3030

31-
**Overview:** This notebook is a quick start guide to community detection in igraph. It covers the initial workflow for detecting communities in networks. (If you look for a more practical learning experience, we recommend starting with this notebook.)
31+
.. **Overview:** This notebook is a quick start guide to community detection in igraph. It covers the initial workflow for detecting communities in networks. (If you look for a more practical learning experience, we recommend starting with this notebook.)
3232
3333
.. raw:: html
3434

@@ -46,7 +46,7 @@ This documentation provides an overview of the notebooks available in the commun
4646
:class-card: sd-card-hover card-deep-orange
4747
:shadow: sm
4848

49-
**Overview:** This notebook covers various community detection algorithms available in igraph. It provides a detailed explanation of these algorithms and when to use them.
49+
.. **Overview:** This notebook covers various community detection algorithms available in igraph. It provides a detailed explanation of these algorithms and when to use them.
5050
5151
.. raw:: html
5252

@@ -64,7 +64,7 @@ This documentation provides an overview of the notebooks available in the commun
6464
:class-card: sd-card-hover card-yellow-orange
6565
:shadow: sm
6666

67-
**Overview:** This notebook provides methods to test the significance of detected communities.
67+
.. **Overview:** This notebook provides methods to test the significance of detected communities.
6868
6969
.. raw:: html
7070

@@ -82,7 +82,7 @@ This documentation provides an overview of the notebooks available in the commun
8282
:class-card: sd-card-hover card-dark-green
8383
:shadow: sm
8484

85-
**Overview:** This notebook provides various methods for generating and visualizing clusters in networks. It includes techniques for visualizing community structures.
85+
.. **Overview:** This notebook provides various methods for generating and visualizing clusters in networks. It includes techniques for visualizing community structures.
8686
8787
.. raw:: html
8888

@@ -100,7 +100,7 @@ This documentation provides an overview of the notebooks available in the commun
100100
:class-card: sd-card-hover card-medium-green
101101
:shadow: sm
102102

103-
**Overview:** This notebook describes hierarchical clustering. It explains how to perform hierarchical clustering on networks and visualize the results.
103+
.. **Overview:** This notebook describes hierarchical clustering. It explains how to perform hierarchical clustering on networks and visualize the results.
104104
105105
.. raw:: html
106106

@@ -118,7 +118,7 @@ This documentation provides an overview of the notebooks available in the commun
118118
:class-card: sd-card-hover card-light-green
119119
:shadow: sm
120120

121-
**Overview:** This notebook introduces the concept of modularity in community detection.
121+
.. **Overview:** This notebook introduces the concept of modularity in community detection.
122122
123123
.. raw:: html
124124

@@ -136,7 +136,7 @@ This documentation provides an overview of the notebooks available in the commun
136136
:class-card: sd-card-hover card-deep-blue
137137
:shadow: sm
138138

139-
**Overview:** This notebook introduces the concept of resolution parameter on the Sierpinski triangle.
139+
.. **Overview:** This notebook introduces the concept of resolution parameter on the Sierpinski triangle.
140140
141141
.. raw:: html
142142

@@ -154,7 +154,7 @@ This documentation provides an overview of the notebooks available in the commun
154154
:class-card: sd-card-hover card-medium-blue
155155
:shadow: sm
156156

157-
**Overview:** This notebook introduces the method of consensus clustering by combining multiple clustering results.
157+
.. **Overview:** This notebook introduces the method of consensus clustering by combining multiple clustering results.
158158
159159
.. raw:: html
160160

@@ -172,7 +172,7 @@ This documentation provides an overview of the notebooks available in the commun
172172
:class-card: sd-card-hover card-light-blue
173173
:shadow: sm
174174

175-
**Overview:** This notebook introduces membership vectors in igraph.
175+
.. **Overview:** This notebook introduces membership vectors in igraph.
176176
177177
.. raw:: html
178178

@@ -190,7 +190,7 @@ This documentation provides an overview of the notebooks available in the commun
190190
:class-card: sd-card-hover card-deep-purple
191191
:shadow: sm
192192

193-
**Overview:** This notebook describes how to work with clusterings in igraph.
193+
.. **Overview:** This notebook describes how to work with clusterings in igraph.
194194
195195
.. raw:: html
196196

@@ -208,7 +208,7 @@ This documentation provides an overview of the notebooks available in the commun
208208
:class-card: sd-card-hover card-medium-purple
209209
:shadow: sm
210210

211-
**Overview:** This notebook introduces all the helper functions used in the community detection guide. It provides a collection of utility functions for community detection tasks.
211+
.. **Overview:** This notebook introduces all the helper functions used in the community detection guide. It provides a collection of utility functions for community detection tasks.
212212
213213
.. raw:: html
214214

0 commit comments

Comments
 (0)