diff --git a/docs/source/alpha/_static/style.css b/docs/source/_static/style.css similarity index 100% rename from docs/source/alpha/_static/style.css rename to docs/source/_static/style.css diff --git a/docs/source/alpha/conf.py b/docs/source/conf.py similarity index 100% rename from docs/source/alpha/conf.py rename to docs/source/conf.py diff --git a/docs/source/alpha/extensions/events.rst b/docs/source/extensions/events.rst similarity index 100% rename from docs/source/alpha/extensions/events.rst rename to docs/source/extensions/events.rst diff --git a/docs/source/alpha/extensions/filters.rst b/docs/source/extensions/filters.rst similarity index 100% rename from docs/source/alpha/extensions/filters.rst rename to docs/source/extensions/filters.rst diff --git a/docs/source/alpha/extensions/index.rst b/docs/source/extensions/index.rst similarity index 100% rename from docs/source/alpha/extensions/index.rst rename to docs/source/extensions/index.rst diff --git a/docs/source/alpha/extensions/mechanisms.rst b/docs/source/extensions/mechanisms.rst similarity index 100% rename from docs/source/alpha/extensions/mechanisms.rst rename to docs/source/extensions/mechanisms.rst diff --git a/docs/source/alpha/extensions/models.rst b/docs/source/extensions/models.rst similarity index 100% rename from docs/source/alpha/extensions/models.rst rename to docs/source/extensions/models.rst diff --git a/docs/source/alpha/graphs.rst b/docs/source/graphs.rst similarity index 100% rename from docs/source/alpha/graphs.rst rename to docs/source/graphs.rst diff --git a/docs/source/alpha/index.rst b/docs/source/index.rst similarity index 100% rename from docs/source/alpha/index.rst rename to docs/source/index.rst diff --git a/docs/source/alpha/logo_simple_dark_bg.png b/docs/source/logo_simple_dark_bg.png similarity index 100% rename from docs/source/alpha/logo_simple_dark_bg.png rename to docs/source/logo_simple_dark_bg.png diff --git a/docs/source/alpha/logo_twitter_v1_white_bg.png b/docs/source/logo_twitter_v1_white_bg.png similarity index 100% rename from docs/source/alpha/logo_twitter_v1_white_bg.png rename to docs/source/logo_twitter_v1_white_bg.png diff --git a/docs/source/alpha/logo_twitter_v2_white_bg.png b/docs/source/logo_twitter_v2_white_bg.png similarity index 100% rename from docs/source/alpha/logo_twitter_v2_white_bg.png rename to docs/source/logo_twitter_v2_white_bg.png diff --git a/docs/source/main/algorithms.rst b/docs/source/main/algorithms.rst deleted file mode 100644 index ad5db8aa..00000000 --- a/docs/source/main/algorithms.rst +++ /dev/null @@ -1,11 +0,0 @@ -Algorithms -========== - -.. automodule:: netin.sampling - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - :glob: - - algorithms/* diff --git a/docs/source/main/algorithms/sampling.rst b/docs/source/main/algorithms/sampling.rst deleted file mode 100644 index 1dd71d25..00000000 --- a/docs/source/main/algorithms/sampling.rst +++ /dev/null @@ -1,23 +0,0 @@ -Sampling -======== - -.. autoclass:: netin.sampling.Sampling - :members: - -.. autoclass:: netin.sampling.RandomNodes - :members: - -.. autoclass:: netin.sampling.RandomEdges - :members: - -.. autoclass:: netin.sampling.RandomNeighbor - :members: - -.. autoclass:: netin.sampling.DegreeRank - :members: - -.. autoclass:: netin.sampling.DegreeGroupRank - :members: - -.. autoclass:: netin.sampling.PartialCrawls - :members: diff --git a/docs/source/main/conf.py b/docs/source/main/conf.py deleted file mode 100644 index 218c422e..00000000 --- a/docs/source/main/conf.py +++ /dev/null @@ -1,43 +0,0 @@ -from netin import __version__ as _version_netin -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = 'NetIn' -copyright = '2023, Fariba Karimi, Lisette Espin-Noboa, Jan Bachmann' -author = 'Fariba Karimi, Lisette Espin-Noboa, Jan Bachmann' -release = _version_netin - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ - # https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html - # Generate documentation from files - 'sphinx.ext.autodoc', - # https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html - # Generate a summary of the project - 'sphinx.ext.autosummary', - # https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html - # Make numpy style docstrings interpretable by sphinx - # 'sphinx.ext.napoleon', -] - -templates_path = ['_templates'] -exclude_patterns = [] - -suppress_warnings = ["ref.citation", "ref.footnote"] - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'alabaster' -html_static_path = ['_static'] -html_logo = 'netin-logo.png' -html_favicon = 'netin-logo.png' -html_theme_options = { -} diff --git a/docs/source/main/generators/directed.rst b/docs/source/main/generators/directed.rst deleted file mode 100644 index e8dda27e..00000000 --- a/docs/source/main/generators/directed.rst +++ /dev/null @@ -1,14 +0,0 @@ -Directed Graphs -=============== - -.. autoclass:: netin.DiGraph - :members: - -.. autoclass:: netin.DH - :members: - -.. autoclass:: netin.DPA - :members: - -.. autoclass:: netin.DPAH - :members: diff --git a/docs/source/main/generators/undirected.rst b/docs/source/main/generators/undirected.rst deleted file mode 100644 index 14ae1b11..00000000 --- a/docs/source/main/generators/undirected.rst +++ /dev/null @@ -1,20 +0,0 @@ -Undirected Graphs -================= - -.. autoclass:: netin.UnDiGraph - :members: - -.. autoclass:: netin.PA - :members: - -.. autoclass:: netin.PATC - :members: - -.. autoclass:: netin.PAH - :members: - -.. autoclass:: netin.PATCH - :members: - -.. autoclass:: netin.TCH - :members: diff --git a/docs/source/main/graphs.rst b/docs/source/main/graphs.rst deleted file mode 100644 index d35f59e7..00000000 --- a/docs/source/main/graphs.rst +++ /dev/null @@ -1,9 +0,0 @@ -Graphs -======= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - :glob: - - generators/* diff --git a/docs/source/main/index.rst b/docs/source/main/index.rst deleted file mode 100644 index 0289619b..00000000 --- a/docs/source/main/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. NetIn documentation master file, created by - sphinx-quickstart on Wed Apr 19 11:08:02 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Network Inequality -================================= - -.. automodule:: netin - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - :glob: - - graphs - algorithms - mechanisms - statistics - visualizations - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/source/main/mechanisms.rst b/docs/source/main/mechanisms.rst deleted file mode 100644 index 414adf52..00000000 --- a/docs/source/main/mechanisms.rst +++ /dev/null @@ -1,8 +0,0 @@ -Mechanisms -========== - -.. autoclass:: netin.TriadicClosure - :members: - -.. autoclass:: netin.Homophily - :members: diff --git a/docs/source/main/netin-logo.png b/docs/source/main/netin-logo.png deleted file mode 100644 index 9e6a5b2e..00000000 Binary files a/docs/source/main/netin-logo.png and /dev/null differ diff --git a/docs/source/main/statistics.rst b/docs/source/main/statistics.rst deleted file mode 100644 index 872dea1b..00000000 --- a/docs/source/main/statistics.rst +++ /dev/null @@ -1,11 +0,0 @@ -Statistics -========== - -.. automodule:: netin.stats.distributions - :members: - -.. automodule:: netin.stats.networks - :members: - -.. automodule:: netin.stats.ranking - :members: diff --git a/docs/source/main/visualizations.rst b/docs/source/main/visualizations.rst deleted file mode 100644 index d6da435e..00000000 --- a/docs/source/main/visualizations.rst +++ /dev/null @@ -1,5 +0,0 @@ -Visualization -============= - -.. automodule:: netin.viz.handlers - :members: diff --git a/docs/source/alpha/models/directed.rst b/docs/source/models/directed.rst similarity index 100% rename from docs/source/alpha/models/directed.rst rename to docs/source/models/directed.rst diff --git a/docs/source/alpha/models/index.rst b/docs/source/models/index.rst similarity index 100% rename from docs/source/alpha/models/index.rst rename to docs/source/models/index.rst diff --git a/docs/source/alpha/models/undirected.rst b/docs/source/models/undirected.rst similarity index 100% rename from docs/source/alpha/models/undirected.rst rename to docs/source/models/undirected.rst diff --git a/docs/source/alpha/netin-logo-bg-white.jpg b/docs/source/netin-logo-bg-white.jpg similarity index 100% rename from docs/source/alpha/netin-logo-bg-white.jpg rename to docs/source/netin-logo-bg-white.jpg diff --git a/docs/source/alpha/netin-logo-text-dark.png b/docs/source/netin-logo-text-dark.png similarity index 100% rename from docs/source/alpha/netin-logo-text-dark.png rename to docs/source/netin-logo-text-dark.png diff --git a/docs/source/alpha/netin-logo.png b/docs/source/netin-logo.png similarity index 100% rename from docs/source/alpha/netin-logo.png rename to docs/source/netin-logo.png diff --git a/docs/source/alpha/node_vectors/index.rst b/docs/source/node_vectors/index.rst similarity index 100% rename from docs/source/alpha/node_vectors/index.rst rename to docs/source/node_vectors/index.rst diff --git a/docs/source/alpha/references.rst b/docs/source/references.rst similarity index 100% rename from docs/source/alpha/references.rst rename to docs/source/references.rst diff --git a/docs/source/alpha/statistics.rst b/docs/source/statistics.rst similarity index 100% rename from docs/source/alpha/statistics.rst rename to docs/source/statistics.rst diff --git a/docs/source/alpha/utilities.rst b/docs/source/utilities.rst similarity index 100% rename from docs/source/alpha/utilities.rst rename to docs/source/utilities.rst diff --git a/docs/source/alpha/visualizations.rst b/docs/source/visualizations.rst similarity index 100% rename from docs/source/alpha/visualizations.rst rename to docs/source/visualizations.rst