From 1e35bd91451e70eb6b38fe596f1acd55011bf0f7 Mon Sep 17 00:00:00 2001 From: GiulioRossetti Date: Tue, 14 May 2024 11:45:43 +0200 Subject: [PATCH] :memo: rtd --- cdlib/__init__.py | 1 + docs/conf.py | 415 ++---------------- docs/reference/algorithms.rst | 1 + .../algs/cdlib.algorithms.agdl.rst | 6 - .../algs/cdlib.algorithms.angel.rst | 6 - .../algs/cdlib.algorithms.aslpaw.rst | 6 - .../algs/cdlib.algorithms.async_fluid.rst | 6 - .../algs/cdlib.algorithms.big_clam.rst | 6 - .../algs/cdlib.algorithms.bimlpa.rst | 6 - .../algs/cdlib.algorithms.conga.rst | 6 - .../algs/cdlib.algorithms.congo.rst | 6 - .../algs/cdlib.algorithms.cpm.rst | 6 - .../algs/cdlib.algorithms.danmf.rst | 6 - .../algs/cdlib.algorithms.demon.rst | 6 - .../algs/cdlib.algorithms.der.rst | 6 - .../algs/cdlib.algorithms.edmot.rst | 6 - .../algs/cdlib.algorithms.ego_networks.rst | 6 - .../algs/cdlib.algorithms.egonet_splitter.rst | 6 - .../algs/cdlib.algorithms.eigenvector.rst | 6 - .../algs/cdlib.algorithms.em.rst | 6 - .../algs/cdlib.algorithms.eva.rst | 6 - .../algs/cdlib.algorithms.frc_fgsn.rst | 6 - .../algs/cdlib.algorithms.gdmp2.rst | 6 - .../algs/cdlib.algorithms.girvan_newman.rst | 6 - .../cdlib.algorithms.greedy_modularity.rst | 6 - ...algorithms.hierarchical_link_community.rst | 6 - .../algs/cdlib.algorithms.ilouvain.rst | 6 - .../algs/cdlib.algorithms.infomap.rst | 6 - .../algs/cdlib.algorithms.kclique.rst | 6 - .../cdlib.algorithms.label_propagation.rst | 6 - .../algs/cdlib.algorithms.lais2.rst | 6 - .../algs/cdlib.algorithms.leiden.rst | 6 - .../algs/cdlib.algorithms.lemon.rst | 6 - .../algs/cdlib.algorithms.lfm.rst | 6 - .../algs/cdlib.algorithms.louvain.rst | 6 - .../cdlib.algorithms.markov_clustering.rst | 6 - .../algs/cdlib.algorithms.multicom.rst | 6 - .../algs/cdlib.algorithms.nnsed.rst | 6 - .../algs/cdlib.algorithms.node_perception.rst | 6 - ...orithms.overlapping_seed_set_expansion.rst | 6 - .../algs/cdlib.algorithms.percomvc.rst | 6 - .../algs/cdlib.algorithms.rb_pots.rst | 6 - .../algs/cdlib.algorithms.rber_pots.rst | 6 - .../algs/cdlib.algorithms.sbm_dl.rst | 6 - .../algs/cdlib.algorithms.sbm_dl_nested.rst | 6 - .../algs/cdlib.algorithms.scan.rst | 6 - ...ib.algorithms.significance_communities.rst | 6 - .../algs/cdlib.algorithms.slpa.rst | 6 - .../algs/cdlib.algorithms.spinglass.rst | 6 - .../cdlib.algorithms.surprise_communities.rst | 6 - .../algs/cdlib.algorithms.walktrap.rst | 6 - .../eval/cdlib.evaluation.FitnessResult.rst | 32 -- .../eval/cdlib.evaluation.MatchingResult.rst | 30 -- ...evaluation.adjusted_mutual_information.rst | 6 - .../cdlib.evaluation.adjusted_rand_index.rst | 6 - ...lib.evaluation.average_internal_degree.rst | 6 - .../eval/cdlib.evaluation.avg_distance.rst | 6 - .../cdlib.evaluation.avg_embeddedness.rst | 6 - .../eval/cdlib.evaluation.avg_odf.rst | 6 - .../cdlib.evaluation.avg_transitivity.rst | 6 - .../eval/cdlib.evaluation.conductance.rst | 6 - .../eval/cdlib.evaluation.cut_ratio.rst | 6 - .../eval/cdlib.evaluation.edges_inside.rst | 6 - ...dlib.evaluation.erdos_renyi_modularity.rst | 6 - .../eval/cdlib.evaluation.expansion.rst | 6 - docs/reference/eval/cdlib.evaluation.f1.rst | 6 - .../eval/cdlib.evaluation.flake_odf.rst | 6 - ...evaluation.fraction_over_median_degree.rst | 6 - .../eval/cdlib.evaluation.hub_dominance.rst | 6 - ...cdlib.evaluation.internal_edge_density.rst | 6 - .../eval/cdlib.evaluation.link_modularity.rst | 6 - .../eval/cdlib.evaluation.max_odf.rst | 6 - .../cdlib.evaluation.modularity_density.rst | 6 - ...ib.evaluation.newman_girvan_modularity.rst | 6 - docs/reference/eval/cdlib.evaluation.nf1.rst | 6 - .../eval/cdlib.evaluation.normalized_cut.rst | 6 - ...aluation.normalized_mutual_information.rst | 6 - .../reference/eval/cdlib.evaluation.omega.rst | 6 - ...ping_normalized_mutual_information_LFK.rst | 6 - ...ping_normalized_mutual_information_MGH.rst | 6 - .../eval/cdlib.evaluation.purity.rst | 6 - .../eval/cdlib.evaluation.scaled_density.rst | 6 - .../eval/cdlib.evaluation.significance.rst | 6 - docs/reference/eval/cdlib.evaluation.size.rst | 6 - .../eval/cdlib.evaluation.surprise.rst | 6 - ...valuation.triangle_participation_ratio.rst | 6 - ...ib.evaluation.variation_of_information.rst | 6 - .../eval/cdlib.evaluation.z_modularity.rst | 6 - .../cdlib.ensemble.BoolParameter.rst | 30 -- .../generated/cdlib.ensemble.Parameter.rst | 32 -- .../cdlib.ensemble.grid_execution.rst | 6 - .../generated/cdlib.ensemble.grid_search.rst | 6 - .../generated/cdlib.ensemble.pool.rst | 6 - .../cdlib.ensemble.pool_grid_filter.rst | 6 - .../cdlib.ensemble.random_search.rst | 6 - .../cdlib.readwrite.read_community_csv.rst | 6 - .../cdlib.readwrite.read_community_json.rst | 6 - .../cdlib.readwrite.write_community_csv.rst | 6 - .../cdlib.readwrite.write_community_json.rst | 6 - .../cdlib.utils.convert_graph_formats.rst | 6 - .../cdlib.utils.nx_node_integer_mapping.rst | 6 - .../cdlib.utils.remap_node_communities.rst | 6 - ...cdlib.viz.plot_com_properties_relation.rst | 6 - .../generated/cdlib.viz.plot_com_stat.rst | 6 - .../cdlib.viz.plot_community_graph.rst | 6 - .../cdlib.viz.plot_network_clusters.rst | 6 - .../generated/cdlib.viz.plot_scoring.rst | 6 - .../generated/cdlib.viz.plot_sim_matrix.rst | 6 - requirements.docs.txt | 4 +- setup.py | 3 +- 110 files changed, 51 insertions(+), 1103 deletions(-) delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.agdl.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.angel.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.aslpaw.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.async_fluid.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.big_clam.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.bimlpa.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.conga.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.congo.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.cpm.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.danmf.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.demon.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.der.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.edmot.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.ego_networks.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.egonet_splitter.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.eigenvector.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.em.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.eva.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.frc_fgsn.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.gdmp2.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.girvan_newman.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.greedy_modularity.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.hierarchical_link_community.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.ilouvain.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.infomap.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.kclique.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.label_propagation.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.lais2.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.leiden.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.lemon.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.lfm.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.louvain.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.markov_clustering.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.multicom.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.nnsed.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.node_perception.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.overlapping_seed_set_expansion.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.percomvc.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.rb_pots.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.rber_pots.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl_nested.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.scan.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.significance_communities.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.slpa.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.spinglass.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.surprise_communities.rst delete mode 100644 docs/reference/cd_algorithms/algs/cdlib.algorithms.walktrap.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.FitnessResult.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.MatchingResult.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.adjusted_mutual_information.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.adjusted_rand_index.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.average_internal_degree.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.avg_distance.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.avg_embeddedness.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.avg_odf.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.avg_transitivity.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.conductance.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.cut_ratio.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.edges_inside.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.erdos_renyi_modularity.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.expansion.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.f1.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.flake_odf.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.fraction_over_median_degree.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.hub_dominance.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.internal_edge_density.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.link_modularity.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.max_odf.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.modularity_density.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.newman_girvan_modularity.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.nf1.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.normalized_cut.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.normalized_mutual_information.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.omega.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_LFK.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_MGH.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.purity.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.scaled_density.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.significance.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.size.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.surprise.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.triangle_participation_ratio.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.variation_of_information.rst delete mode 100644 docs/reference/eval/cdlib.evaluation.z_modularity.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.BoolParameter.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.Parameter.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.grid_execution.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.grid_search.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.pool.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.pool_grid_filter.rst delete mode 100644 docs/reference/generated/cdlib.ensemble.random_search.rst delete mode 100644 docs/reference/generated/cdlib.readwrite.read_community_csv.rst delete mode 100644 docs/reference/generated/cdlib.readwrite.read_community_json.rst delete mode 100644 docs/reference/generated/cdlib.readwrite.write_community_csv.rst delete mode 100644 docs/reference/generated/cdlib.readwrite.write_community_json.rst delete mode 100644 docs/reference/generated/cdlib.utils.convert_graph_formats.rst delete mode 100644 docs/reference/generated/cdlib.utils.nx_node_integer_mapping.rst delete mode 100644 docs/reference/generated/cdlib.utils.remap_node_communities.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_com_properties_relation.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_com_stat.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_community_graph.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_network_clusters.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_scoring.rst delete mode 100644 docs/reference/generated/cdlib.viz.plot_sim_matrix.rst diff --git a/cdlib/__init__.py b/cdlib/__init__.py index 398fd775..3533b526 100644 --- a/cdlib/__init__.py +++ b/cdlib/__init__.py @@ -1,3 +1,4 @@ +__version__ = '0.3.1' from cdlib.classes.node_clustering import NodeClustering from cdlib.classes.edge_clustering import EdgeClustering from cdlib.classes.fuzzy_node_clustering import FuzzyNodeClustering diff --git a/docs/conf.py b/docs/conf.py index f00b72d2..469bc1c2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,31 +1,47 @@ -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# CDlib documentation build configuration file, created by -# sphinx-quickstart on Wed May 24 10:59:33 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -import sys -import os -#from mock import Mock as MagicMock +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import sys, os import sphinx_rtd_theme +sys.path.append(os.path.join(os.path.dirname(__file__), '..')) +from cdlib import __version__ -#class Mock(MagicMock): -# @classmethod -# def __getattr__(cls, name): -# return MagicMock() +html_theme = 'sphinx_rtd_theme' +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -autodoc_mock_imports = [ +version = __version__ +# The full version, including alpha/beta/rc tags. +release = version -#MOCK_MODULES = [ +html_theme_options = { + 'collapse_navigation': False, + 'display_version': False, + "navigation_depth": 3, +} + +# -- Project information ----------------------------------------------------- + +project = 'CDlib' +copyright = '2024, Giulio Rossetti' +author = 'Giulio Rossetti' + +# The full version, including alpha/beta/rc tags +release = '0.3.1' + +autodoc_mock_imports = [ "graph_tool.all", "graph_tool", "thresholdclustering.thresholdclustering", @@ -84,47 +100,12 @@ "clusim.sim", "clusim.clustering", ] -#sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) - -#html_theme = "sphinx_rtd_theme" -#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - - -#on_rtd = os.environ.get('READTHEDOCS') == 'True' -#if on_rtd: -# html_theme = 'default' -#else: -# import sphinx_rtd_theme -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -html_theme_options = { - 'collapse_navigation': False, - 'display_version': False, - "navigation_depth": 3, -} - - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("../")) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.7.5' +# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. - -autodoc_default_options = { - 'autosummary': True, -} - - extensions = [ "sphinx.ext.mathjax", "sphinx.ext.githubpages", @@ -132,329 +113,23 @@ "sphinx.ext.autosummary", ] - # Add any paths that contain templates here, relative to this directory. -#templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = "CDlib" -copyright = "2019, Giulio Rossetti" -author = "Giulio Rossetti" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -#version = "0.3.1" -# The full version, including alpha/beta/rc tags. -#release = "0.3.1" - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' +templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -add_module_names = False -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = ['cdlib.algorithms'] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -todo_include_todos = False - -# -- Options for HTML output ---------------------------------------------- +# -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# html_theme = 'alabaster' - -# 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. -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. -# " v documentation" by default. -html_title = "CDlib - Community Discovery library" - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = "CDlib" - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = "cdlib_new.png" - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None +# +#html_theme = 'alabaster' # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] -html_context = {"css_files": ["_static/css/custom.css"]} - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# html_last_updated_fmt = None - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is ensemble. -# html_domain_indices = True - -# If false, no index is ensemble. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "CDlibdoc" - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -#latex_documents = [ -# (master_doc, "CDlib.tex", "CDlib Documentation", "Giulio Rossetti", "manual") -#] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is ensemble. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -#man_pages = [(master_doc, "CDlib", "CDlib Documentation", [author], 1)] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -#texinfo_documents = [ -# ( -# master_doc, -# "CDlib", -# "CDlib Documentation", -# author, -# "CDlib", -# "Community Discovery Library", -# "Miscellaneous", -# ) -#] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is ensemble. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -#epub_title = project -#epub_author = author -#epub_publisher = author -#epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -# epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not -# optimized for small screen space, using the same theme for HTML and epub -# output is usually not wise. This defaults to 'epub', a theme designed to save -# visual space. -# epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -# epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -# epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# epub_identifier = '' - -# A unique identification for the text. -# epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -# epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -# epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -# epub_pre_files = [] - -# HTML files that should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -# epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = ["search.html"] - -# The depth of the table of contents in toc.ncx. -# epub_tocdepth = 3 - -# Allow duplicate toc entries. -# epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -# epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -# epub_fix_images = False - -# Scale large images. -# epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# epub_show_urls = 'inline' - -# If false, no index is ensemble. -# epub_use_index = True - -autosummary_generate = True +html_static_path = ['_static'] \ No newline at end of file diff --git a/docs/reference/algorithms.rst b/docs/reference/algorithms.rst index fe6ba204..cf57ad18 100644 --- a/docs/reference/algorithms.rst +++ b/docs/reference/algorithms.rst @@ -32,6 +32,7 @@ This documentation follows the same rationale. :maxdepth: 1 cd_algorithms/node_clustering.rst + cd_algorithms/edge_clustering.rst cd_algorithms/temporal_clustering.rst diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.agdl.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.agdl.rst deleted file mode 100644 index a8d7a681..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.agdl.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.agdl -===================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: agdl \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.angel.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.angel.rst deleted file mode 100644 index e4d7625c..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.angel.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.angel -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: angel \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.aslpaw.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.aslpaw.rst deleted file mode 100644 index 76e30fb5..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.aslpaw.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.aslpaw -======================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: aslpaw \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.async_fluid.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.async_fluid.rst deleted file mode 100644 index 10068b9a..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.async_fluid.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.async\_fluid -============================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: async_fluid \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.big_clam.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.big_clam.rst deleted file mode 100644 index 1e662ea6..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.big_clam.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.big\_clam -========================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: big_clam \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.bimlpa.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.bimlpa.rst deleted file mode 100644 index 5fc88f1d..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.bimlpa.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.bimlpa -======================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: bimlpa \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.conga.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.conga.rst deleted file mode 100644 index 137e9705..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.conga.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.conga -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: conga \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.congo.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.congo.rst deleted file mode 100644 index 299db90f..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.congo.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.congo -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: congo \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.cpm.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.cpm.rst deleted file mode 100644 index 2f10233d..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.cpm.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.cpm -==================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: cpm \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.danmf.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.danmf.rst deleted file mode 100644 index c3e410f1..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.danmf.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.danmf -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: danmf \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.demon.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.demon.rst deleted file mode 100644 index 037ccf61..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.demon.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.demon -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: demon \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.der.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.der.rst deleted file mode 100644 index 513b1545..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.der.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.der -==================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: der \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.edmot.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.edmot.rst deleted file mode 100644 index 7c445f20..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.edmot.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.edmot -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: edmot \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.ego_networks.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.ego_networks.rst deleted file mode 100644 index b50b4802..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.ego_networks.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.ego\_networks -============================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: ego_networks \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.egonet_splitter.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.egonet_splitter.rst deleted file mode 100644 index 7c86aa9d..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.egonet_splitter.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.egonet\_splitter -================================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: egonet_splitter \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.eigenvector.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.eigenvector.rst deleted file mode 100644 index 48391e55..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.eigenvector.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.eigenvector -============================ - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: eigenvector \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.em.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.em.rst deleted file mode 100644 index 27d6669c..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.em.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.em -=================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: em \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.eva.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.eva.rst deleted file mode 100644 index dc86b578..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.eva.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.eva -==================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: eva \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.frc_fgsn.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.frc_fgsn.rst deleted file mode 100644 index d564aa8e..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.frc_fgsn.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.frc\_fgsn -========================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: frc_fgsn \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.gdmp2.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.gdmp2.rst deleted file mode 100644 index 53d36b93..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.gdmp2.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.gdmp2 -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: gdmp2 \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.girvan_newman.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.girvan_newman.rst deleted file mode 100644 index 95114ba9..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.girvan_newman.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.girvan\_newman -=============================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: girvan_newman \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.greedy_modularity.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.greedy_modularity.rst deleted file mode 100644 index cad356f6..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.greedy_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.greedy\_modularity -=================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: greedy_modularity \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.hierarchical_link_community.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.hierarchical_link_community.rst deleted file mode 100644 index c50dad1f..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.hierarchical_link_community.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.hierarchical\_link\_community -============================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: hierarchical_link_community \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.ilouvain.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.ilouvain.rst deleted file mode 100644 index 4ea6b0e5..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.ilouvain.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.ilouvain -========================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: ilouvain \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.infomap.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.infomap.rst deleted file mode 100644 index e6cc8b01..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.infomap.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.infomap -======================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: infomap \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.kclique.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.kclique.rst deleted file mode 100644 index 7e802b83..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.kclique.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.kclique -======================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: kclique \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.label_propagation.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.label_propagation.rst deleted file mode 100644 index 86cda33e..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.label_propagation.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.label\_propagation -=================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: label_propagation \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lais2.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.lais2.rst deleted file mode 100644 index 8c5c8414..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lais2.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.lais2 -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: lais2 \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.leiden.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.leiden.rst deleted file mode 100644 index b8553ee1..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.leiden.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.leiden -======================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: leiden \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lemon.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.lemon.rst deleted file mode 100644 index f2c478da..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lemon.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.lemon -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: lemon \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lfm.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.lfm.rst deleted file mode 100644 index 2effea2a..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.lfm.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.lfm -==================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: lfm \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.louvain.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.louvain.rst deleted file mode 100644 index 562af449..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.louvain.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.louvain -======================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: louvain \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.markov_clustering.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.markov_clustering.rst deleted file mode 100644 index 6ee5c153..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.markov_clustering.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.markov\_clustering -=================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: markov_clustering \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.multicom.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.multicom.rst deleted file mode 100644 index 59ea80dd..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.multicom.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.multicom -========================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: multicom \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.nnsed.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.nnsed.rst deleted file mode 100644 index ff92d1ff..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.nnsed.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.nnsed -====================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: nnsed \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.node_perception.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.node_perception.rst deleted file mode 100644 index db37c9f8..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.node_perception.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.node\_perception -================================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: node_perception \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.overlapping_seed_set_expansion.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.overlapping_seed_set_expansion.rst deleted file mode 100644 index 91cd3445..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.overlapping_seed_set_expansion.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.overlapping\_seed\_set\_expansion -================================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: overlapping_seed_set_expansion \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.percomvc.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.percomvc.rst deleted file mode 100644 index e66e3572..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.percomvc.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.percomvc -========================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: percomvc \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.rb_pots.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.rb_pots.rst deleted file mode 100644 index 0399224e..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.rb_pots.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.rb\_pots -========================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: rb_pots \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.rber_pots.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.rber_pots.rst deleted file mode 100644 index a5f0307e..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.rber_pots.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.rber\_pots -=========================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: rber_pots \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl.rst deleted file mode 100644 index d2ec2fa0..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.sbm\_dl -======================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: sbm_dl \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl_nested.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl_nested.rst deleted file mode 100644 index e98890ff..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.sbm_dl_nested.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.sbm\_dl\_nested -================================ - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: sbm_dl_nested \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.scan.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.scan.rst deleted file mode 100644 index 71c45785..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.scan.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.scan -===================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: scan \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.significance_communities.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.significance_communities.rst deleted file mode 100644 index ef7d11e2..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.significance_communities.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.significance\_communities -========================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: significance_communities \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.slpa.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.slpa.rst deleted file mode 100644 index 3c541d7d..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.slpa.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.slpa -===================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: slpa \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.spinglass.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.spinglass.rst deleted file mode 100644 index 59bd6e2f..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.spinglass.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.spinglass -========================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: spinglass \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.surprise_communities.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.surprise_communities.rst deleted file mode 100644 index 537675c1..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.surprise_communities.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.surprise\_communities -====================================== - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: surprise_communities \ No newline at end of file diff --git a/docs/reference/cd_algorithms/algs/cdlib.algorithms.walktrap.rst b/docs/reference/cd_algorithms/algs/cdlib.algorithms.walktrap.rst deleted file mode 100644 index e832d134..00000000 --- a/docs/reference/cd_algorithms/algs/cdlib.algorithms.walktrap.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.algorithms.walktrap -========================= - -.. currentmodule:: cdlib.algorithms - -.. autofunction:: walktrap \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.FitnessResult.rst b/docs/reference/eval/cdlib.evaluation.FitnessResult.rst deleted file mode 100644 index 6b15ba79..00000000 --- a/docs/reference/eval/cdlib.evaluation.FitnessResult.rst +++ /dev/null @@ -1,32 +0,0 @@ -cdlib.evaluation.FitnessResult -============================== - -.. currentmodule:: cdlib.evaluation - -.. autoclass:: FitnessResult - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FitnessResult.count - ~FitnessResult.index - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FitnessResult.max - ~FitnessResult.min - ~FitnessResult.score - ~FitnessResult.std - - \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.MatchingResult.rst b/docs/reference/eval/cdlib.evaluation.MatchingResult.rst deleted file mode 100644 index b44ad8c4..00000000 --- a/docs/reference/eval/cdlib.evaluation.MatchingResult.rst +++ /dev/null @@ -1,30 +0,0 @@ -cdlib.evaluation.MatchingResult -=============================== - -.. currentmodule:: cdlib.evaluation - -.. autoclass:: MatchingResult - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MatchingResult.count - ~MatchingResult.index - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~MatchingResult.score - ~MatchingResult.std - - \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.adjusted_mutual_information.rst b/docs/reference/eval/cdlib.evaluation.adjusted_mutual_information.rst deleted file mode 100644 index bae64852..00000000 --- a/docs/reference/eval/cdlib.evaluation.adjusted_mutual_information.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.adjusted\_mutual\_information -============================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: adjusted_mutual_information \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.adjusted_rand_index.rst b/docs/reference/eval/cdlib.evaluation.adjusted_rand_index.rst deleted file mode 100644 index d6d163e3..00000000 --- a/docs/reference/eval/cdlib.evaluation.adjusted_rand_index.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.adjusted\_rand\_index -====================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: adjusted_rand_index \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.average_internal_degree.rst b/docs/reference/eval/cdlib.evaluation.average_internal_degree.rst deleted file mode 100644 index c2ee27c8..00000000 --- a/docs/reference/eval/cdlib.evaluation.average_internal_degree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.average\_internal\_degree -========================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: average_internal_degree \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.avg_distance.rst b/docs/reference/eval/cdlib.evaluation.avg_distance.rst deleted file mode 100644 index a8714c13..00000000 --- a/docs/reference/eval/cdlib.evaluation.avg_distance.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.avg\_distance -============================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: avg_distance \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.avg_embeddedness.rst b/docs/reference/eval/cdlib.evaluation.avg_embeddedness.rst deleted file mode 100644 index f56a8109..00000000 --- a/docs/reference/eval/cdlib.evaluation.avg_embeddedness.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.avg\_embeddedness -================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: avg_embeddedness \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.avg_odf.rst b/docs/reference/eval/cdlib.evaluation.avg_odf.rst deleted file mode 100644 index cf038712..00000000 --- a/docs/reference/eval/cdlib.evaluation.avg_odf.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.avg\_odf -========================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: avg_odf \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.avg_transitivity.rst b/docs/reference/eval/cdlib.evaluation.avg_transitivity.rst deleted file mode 100644 index 25ecdf05..00000000 --- a/docs/reference/eval/cdlib.evaluation.avg_transitivity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.avg\_transitivity -================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: avg_transitivity \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.conductance.rst b/docs/reference/eval/cdlib.evaluation.conductance.rst deleted file mode 100644 index 872fee9e..00000000 --- a/docs/reference/eval/cdlib.evaluation.conductance.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.conductance -============================ - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: conductance \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.cut_ratio.rst b/docs/reference/eval/cdlib.evaluation.cut_ratio.rst deleted file mode 100644 index cecf16d8..00000000 --- a/docs/reference/eval/cdlib.evaluation.cut_ratio.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.cut\_ratio -=========================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: cut_ratio \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.edges_inside.rst b/docs/reference/eval/cdlib.evaluation.edges_inside.rst deleted file mode 100644 index fa465f45..00000000 --- a/docs/reference/eval/cdlib.evaluation.edges_inside.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.edges\_inside -============================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: edges_inside \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.erdos_renyi_modularity.rst b/docs/reference/eval/cdlib.evaluation.erdos_renyi_modularity.rst deleted file mode 100644 index 3361d312..00000000 --- a/docs/reference/eval/cdlib.evaluation.erdos_renyi_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.erdos\_renyi\_modularity -========================================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: erdos_renyi_modularity \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.expansion.rst b/docs/reference/eval/cdlib.evaluation.expansion.rst deleted file mode 100644 index 128f0eb7..00000000 --- a/docs/reference/eval/cdlib.evaluation.expansion.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.expansion -========================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: expansion \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.f1.rst b/docs/reference/eval/cdlib.evaluation.f1.rst deleted file mode 100644 index ac881116..00000000 --- a/docs/reference/eval/cdlib.evaluation.f1.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.f1 -=================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: f1 \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.flake_odf.rst b/docs/reference/eval/cdlib.evaluation.flake_odf.rst deleted file mode 100644 index 2d8033ed..00000000 --- a/docs/reference/eval/cdlib.evaluation.flake_odf.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.flake\_odf -=========================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: flake_odf \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.fraction_over_median_degree.rst b/docs/reference/eval/cdlib.evaluation.fraction_over_median_degree.rst deleted file mode 100644 index febe965f..00000000 --- a/docs/reference/eval/cdlib.evaluation.fraction_over_median_degree.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.fraction\_over\_median\_degree -=============================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: fraction_over_median_degree \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.hub_dominance.rst b/docs/reference/eval/cdlib.evaluation.hub_dominance.rst deleted file mode 100644 index 67b71ed8..00000000 --- a/docs/reference/eval/cdlib.evaluation.hub_dominance.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.hub\_dominance -=============================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: hub_dominance \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.internal_edge_density.rst b/docs/reference/eval/cdlib.evaluation.internal_edge_density.rst deleted file mode 100644 index bc92e372..00000000 --- a/docs/reference/eval/cdlib.evaluation.internal_edge_density.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.internal\_edge\_density -======================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: internal_edge_density \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.link_modularity.rst b/docs/reference/eval/cdlib.evaluation.link_modularity.rst deleted file mode 100644 index ee7c5d27..00000000 --- a/docs/reference/eval/cdlib.evaluation.link_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.link\_modularity -================================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: link_modularity \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.max_odf.rst b/docs/reference/eval/cdlib.evaluation.max_odf.rst deleted file mode 100644 index d397c413..00000000 --- a/docs/reference/eval/cdlib.evaluation.max_odf.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.max\_odf -========================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: max_odf \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.modularity_density.rst b/docs/reference/eval/cdlib.evaluation.modularity_density.rst deleted file mode 100644 index 459713ed..00000000 --- a/docs/reference/eval/cdlib.evaluation.modularity_density.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.modularity\_density -==================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: modularity_density \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.newman_girvan_modularity.rst b/docs/reference/eval/cdlib.evaluation.newman_girvan_modularity.rst deleted file mode 100644 index ef7fb359..00000000 --- a/docs/reference/eval/cdlib.evaluation.newman_girvan_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.newman\_girvan\_modularity -=========================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: newman_girvan_modularity \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.nf1.rst b/docs/reference/eval/cdlib.evaluation.nf1.rst deleted file mode 100644 index 6326b9e9..00000000 --- a/docs/reference/eval/cdlib.evaluation.nf1.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.nf1 -==================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: nf1 \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.normalized_cut.rst b/docs/reference/eval/cdlib.evaluation.normalized_cut.rst deleted file mode 100644 index 84d17a6e..00000000 --- a/docs/reference/eval/cdlib.evaluation.normalized_cut.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.normalized\_cut -================================ - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: normalized_cut \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.normalized_mutual_information.rst b/docs/reference/eval/cdlib.evaluation.normalized_mutual_information.rst deleted file mode 100644 index 9dcf0975..00000000 --- a/docs/reference/eval/cdlib.evaluation.normalized_mutual_information.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.normalized\_mutual\_information -================================================ - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: normalized_mutual_information \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.omega.rst b/docs/reference/eval/cdlib.evaluation.omega.rst deleted file mode 100644 index 502bcf65..00000000 --- a/docs/reference/eval/cdlib.evaluation.omega.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.omega -====================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: omega \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_LFK.rst b/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_LFK.rst deleted file mode 100644 index f0c2183c..00000000 --- a/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_LFK.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.overlapping\_normalized\_mutual\_information\_LFK -================================================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: overlapping_normalized_mutual_information_LFK \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_MGH.rst b/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_MGH.rst deleted file mode 100644 index 397d50b2..00000000 --- a/docs/reference/eval/cdlib.evaluation.overlapping_normalized_mutual_information_MGH.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.overlapping\_normalized\_mutual\_information\_MGH -================================================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: overlapping_normalized_mutual_information_MGH \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.purity.rst b/docs/reference/eval/cdlib.evaluation.purity.rst deleted file mode 100644 index cc482433..00000000 --- a/docs/reference/eval/cdlib.evaluation.purity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.purity -======================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: purity \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.scaled_density.rst b/docs/reference/eval/cdlib.evaluation.scaled_density.rst deleted file mode 100644 index a5d18be8..00000000 --- a/docs/reference/eval/cdlib.evaluation.scaled_density.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.scaled\_density -================================ - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: scaled_density \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.significance.rst b/docs/reference/eval/cdlib.evaluation.significance.rst deleted file mode 100644 index 60200472..00000000 --- a/docs/reference/eval/cdlib.evaluation.significance.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.significance -============================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: significance \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.size.rst b/docs/reference/eval/cdlib.evaluation.size.rst deleted file mode 100644 index 3af86d69..00000000 --- a/docs/reference/eval/cdlib.evaluation.size.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.size -===================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: size \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.surprise.rst b/docs/reference/eval/cdlib.evaluation.surprise.rst deleted file mode 100644 index 78a90934..00000000 --- a/docs/reference/eval/cdlib.evaluation.surprise.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.surprise -========================= - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: surprise \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.triangle_participation_ratio.rst b/docs/reference/eval/cdlib.evaluation.triangle_participation_ratio.rst deleted file mode 100644 index a5a64bb5..00000000 --- a/docs/reference/eval/cdlib.evaluation.triangle_participation_ratio.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.triangle\_participation\_ratio -=============================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: triangle_participation_ratio \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.variation_of_information.rst b/docs/reference/eval/cdlib.evaluation.variation_of_information.rst deleted file mode 100644 index 953053c5..00000000 --- a/docs/reference/eval/cdlib.evaluation.variation_of_information.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.variation\_of\_information -=========================================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: variation_of_information \ No newline at end of file diff --git a/docs/reference/eval/cdlib.evaluation.z_modularity.rst b/docs/reference/eval/cdlib.evaluation.z_modularity.rst deleted file mode 100644 index ef8e782d..00000000 --- a/docs/reference/eval/cdlib.evaluation.z_modularity.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.evaluation.z\_modularity -============================== - -.. currentmodule:: cdlib.evaluation - -.. autofunction:: z_modularity \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.BoolParameter.rst b/docs/reference/generated/cdlib.ensemble.BoolParameter.rst deleted file mode 100644 index 9a1499cc..00000000 --- a/docs/reference/generated/cdlib.ensemble.BoolParameter.rst +++ /dev/null @@ -1,30 +0,0 @@ -cdlib.ensemble.BoolParameter -============================ - -.. currentmodule:: cdlib.ensemble - -.. autoclass:: BoolParameter - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BoolParameter.count - ~BoolParameter.index - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~BoolParameter.name - ~BoolParameter.value - - \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.Parameter.rst b/docs/reference/generated/cdlib.ensemble.Parameter.rst deleted file mode 100644 index 4e4daa47..00000000 --- a/docs/reference/generated/cdlib.ensemble.Parameter.rst +++ /dev/null @@ -1,32 +0,0 @@ -cdlib.ensemble.Parameter -======================== - -.. currentmodule:: cdlib.ensemble - -.. autoclass:: Parameter - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Parameter.count - ~Parameter.index - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Parameter.end - ~Parameter.name - ~Parameter.start - ~Parameter.step - - \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.grid_execution.rst b/docs/reference/generated/cdlib.ensemble.grid_execution.rst deleted file mode 100644 index 4652afd9..00000000 --- a/docs/reference/generated/cdlib.ensemble.grid_execution.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.ensemble.grid\_execution -============================== - -.. currentmodule:: cdlib.ensemble - -.. autofunction:: grid_execution \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.grid_search.rst b/docs/reference/generated/cdlib.ensemble.grid_search.rst deleted file mode 100644 index d73dc23c..00000000 --- a/docs/reference/generated/cdlib.ensemble.grid_search.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.ensemble.grid\_search -=========================== - -.. currentmodule:: cdlib.ensemble - -.. autofunction:: grid_search \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.pool.rst b/docs/reference/generated/cdlib.ensemble.pool.rst deleted file mode 100644 index 8c9fb088..00000000 --- a/docs/reference/generated/cdlib.ensemble.pool.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.ensemble.pool -=================== - -.. currentmodule:: cdlib.ensemble - -.. autofunction:: pool \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.pool_grid_filter.rst b/docs/reference/generated/cdlib.ensemble.pool_grid_filter.rst deleted file mode 100644 index a42fa5fe..00000000 --- a/docs/reference/generated/cdlib.ensemble.pool_grid_filter.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.ensemble.pool\_grid\_filter -================================= - -.. currentmodule:: cdlib.ensemble - -.. autofunction:: pool_grid_filter \ No newline at end of file diff --git a/docs/reference/generated/cdlib.ensemble.random_search.rst b/docs/reference/generated/cdlib.ensemble.random_search.rst deleted file mode 100644 index e695437a..00000000 --- a/docs/reference/generated/cdlib.ensemble.random_search.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.ensemble.random\_search -============================= - -.. currentmodule:: cdlib.ensemble - -.. autofunction:: random_search \ No newline at end of file diff --git a/docs/reference/generated/cdlib.readwrite.read_community_csv.rst b/docs/reference/generated/cdlib.readwrite.read_community_csv.rst deleted file mode 100644 index 4a2413ec..00000000 --- a/docs/reference/generated/cdlib.readwrite.read_community_csv.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.readwrite.read\_community\_csv -==================================== - -.. currentmodule:: cdlib.readwrite - -.. autofunction:: read_community_csv \ No newline at end of file diff --git a/docs/reference/generated/cdlib.readwrite.read_community_json.rst b/docs/reference/generated/cdlib.readwrite.read_community_json.rst deleted file mode 100644 index ff05dfbc..00000000 --- a/docs/reference/generated/cdlib.readwrite.read_community_json.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.readwrite.read\_community\_json -===================================== - -.. currentmodule:: cdlib.readwrite - -.. autofunction:: read_community_json \ No newline at end of file diff --git a/docs/reference/generated/cdlib.readwrite.write_community_csv.rst b/docs/reference/generated/cdlib.readwrite.write_community_csv.rst deleted file mode 100644 index 11fbf1d3..00000000 --- a/docs/reference/generated/cdlib.readwrite.write_community_csv.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.readwrite.write\_community\_csv -===================================== - -.. currentmodule:: cdlib.readwrite - -.. autofunction:: write_community_csv \ No newline at end of file diff --git a/docs/reference/generated/cdlib.readwrite.write_community_json.rst b/docs/reference/generated/cdlib.readwrite.write_community_json.rst deleted file mode 100644 index bec393f5..00000000 --- a/docs/reference/generated/cdlib.readwrite.write_community_json.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.readwrite.write\_community\_json -====================================== - -.. currentmodule:: cdlib.readwrite - -.. autofunction:: write_community_json \ No newline at end of file diff --git a/docs/reference/generated/cdlib.utils.convert_graph_formats.rst b/docs/reference/generated/cdlib.utils.convert_graph_formats.rst deleted file mode 100644 index 1519d4a0..00000000 --- a/docs/reference/generated/cdlib.utils.convert_graph_formats.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.utils.convert\_graph\_formats -=================================== - -.. currentmodule:: cdlib.utils - -.. autofunction:: convert_graph_formats \ No newline at end of file diff --git a/docs/reference/generated/cdlib.utils.nx_node_integer_mapping.rst b/docs/reference/generated/cdlib.utils.nx_node_integer_mapping.rst deleted file mode 100644 index da1fa88a..00000000 --- a/docs/reference/generated/cdlib.utils.nx_node_integer_mapping.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.utils.nx\_node\_integer\_mapping -====================================== - -.. currentmodule:: cdlib.utils - -.. autofunction:: nx_node_integer_mapping \ No newline at end of file diff --git a/docs/reference/generated/cdlib.utils.remap_node_communities.rst b/docs/reference/generated/cdlib.utils.remap_node_communities.rst deleted file mode 100644 index 1eab40e4..00000000 --- a/docs/reference/generated/cdlib.utils.remap_node_communities.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.utils.remap\_node\_communities -==================================== - -.. currentmodule:: cdlib.utils - -.. autofunction:: remap_node_communities \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_com_properties_relation.rst b/docs/reference/generated/cdlib.viz.plot_com_properties_relation.rst deleted file mode 100644 index 303d2b3b..00000000 --- a/docs/reference/generated/cdlib.viz.plot_com_properties_relation.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_com\_properties\_relation -========================================= - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_com_properties_relation \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_com_stat.rst b/docs/reference/generated/cdlib.viz.plot_com_stat.rst deleted file mode 100644 index b7d41518..00000000 --- a/docs/reference/generated/cdlib.viz.plot_com_stat.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_com\_stat -========================= - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_com_stat \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_community_graph.rst b/docs/reference/generated/cdlib.viz.plot_community_graph.rst deleted file mode 100644 index ff3d8c2a..00000000 --- a/docs/reference/generated/cdlib.viz.plot_community_graph.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_community\_graph -================================ - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_community_graph \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_network_clusters.rst b/docs/reference/generated/cdlib.viz.plot_network_clusters.rst deleted file mode 100644 index 8da22274..00000000 --- a/docs/reference/generated/cdlib.viz.plot_network_clusters.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_network\_clusters -================================= - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_network_clusters \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_scoring.rst b/docs/reference/generated/cdlib.viz.plot_scoring.rst deleted file mode 100644 index 5348fcfe..00000000 --- a/docs/reference/generated/cdlib.viz.plot_scoring.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_scoring -======================= - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_scoring \ No newline at end of file diff --git a/docs/reference/generated/cdlib.viz.plot_sim_matrix.rst b/docs/reference/generated/cdlib.viz.plot_sim_matrix.rst deleted file mode 100644 index 1ee8e4ac..00000000 --- a/docs/reference/generated/cdlib.viz.plot_sim_matrix.rst +++ /dev/null @@ -1,6 +0,0 @@ -cdlib.viz.plot\_sim\_matrix -=========================== - -.. currentmodule:: cdlib.viz - -.. autofunction:: plot_sim_matrix \ No newline at end of file diff --git a/requirements.docs.txt b/requirements.docs.txt index 7b206c50..383c0705 100644 --- a/requirements.docs.txt +++ b/requirements.docs.txt @@ -13,9 +13,9 @@ pandas eva_lcd bimlpa ASLPAw -sphinx==1.7.5 # pyup: ignore +sphinx # ==1.7.5 # pyup: ignore pooch dynetx matplotlib sphinx_rtd_theme # ==1.0.0 -jinja2<3.1.0 \ No newline at end of file +# jinja2<3.1.0 \ No newline at end of file diff --git a/setup.py b/setup.py index ec30b6fa..c562609a 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ from setuptools import setup, find_packages from codecs import open from os import path +from cdlib import __version__ __author__ = "Giulio Rossetti" __license__ = "BSD-2-Clause" @@ -19,7 +20,7 @@ setup( name="cdlib", - version="0.3.1", + version=__version__, license="BSD-Clause-2", description="Community Discovery Library", url="https://github.com/GiulioRossetti/cdlib",