Split the API documentation page in several smaller ones.

doc/.readthedocs.yaml

@@ -7,10 +7,16 @@ build:
   os: ubuntu-24.04
   tools:
     python: "3.13"
+  jobs:
+    pre_install:
+      - pip install --no-deps dgf
+    build:
+      html:
+        - python -m mkdocs build -v --clean --site-dir $READTHEDOCS_OUTPUT/html --config-file doc/mkdocs.yml
 
 mkdocs:
    configuration: doc/mkdocs.yml
 
 python:
   install:
-    - requirements: doc/requirements.txt
+    - requirements: doc/requirements.txt

doc/docs/api/dgf-analyse.md

@@ -0,0 +1,19 @@
+---
+hide:
+  - toc
+---
+
+# dgf.analyse
+
+## dgf.analyse.feature_statistics  # {: #section-feature-statistics}
+::: dgf.analyse.feature_statistics
+
+## dgf.analyse.feature_statistics_from_graphs  # {: #section-feature-statistics-from-graphs}
+::: dgf.analyse.feature_statistics_from_graphs
+
+## dgf.analyse.padding_from_graph_generator  # {: #section-padding-from-graph-generator}
+::: dgf.analyse.padding_from_graph_generator
+
+## dgf.analyse.print_schema  # {: #section-print-schema}
+::: dgf.analyse.print_schema
+

doc/docs/api/dgf-beam-analyse.md

@@ -0,0 +1,13 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam.analyse
+
+## dgf.beam.analyse.feature_statistics  # {: #section-feature-statistics}
+::: dgf.beam.analyse.feature_statistics
+
+## dgf.beam.analyse.feature_statistics_from_graphs  # {: #section-feature-statistics-from-graphs}
+::: dgf.beam.analyse.feature_statistics_from_graphs
+

doc/docs/api/dgf-beam-data.md

@@ -0,0 +1,25 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam.data
+
+## dgf.beam.data.Edge  # {: #section-edge}
+::: dgf.beam.data.Edge
+
+## dgf.beam.data.Graph  # {: #section-graph}
+::: dgf.beam.data.Graph
+
+## dgf.beam.data.HeterogeniousGraph  # {: #section-heterogeniousgraph}
+::: dgf.beam.data.HeterogeniousGraph
+
+## dgf.beam.data.HomogeneousGraph  # {: #section-homogeneousgraph}
+::: dgf.beam.data.HomogeneousGraph
+
+## dgf.beam.data.KeyedInMemoryGraph  # {: #section-keyedinmemorygraph}
+::: dgf.beam.data.KeyedInMemoryGraph
+
+## dgf.beam.data.Node  # {: #section-node}
+::: dgf.beam.data.Node
+

doc/docs/api/dgf-beam-io.md

@@ -0,0 +1,46 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam.io
+
+## dgf.beam.io.CreateSpannerTables  # {: #section-createspannertables}
+::: dgf.beam.io.CreateSpannerTables
+
+## dgf.beam.io.read_bigquery_graph  # {: #section-read-bigquery-graph}
+::: dgf.beam.io.read_bigquery_graph
+
+## dgf.beam.io.read_graph  # {: #section-read-graph}
+::: dgf.beam.io.read_graph
+
+## dgf.beam.io.read_graphai_hgraph  # {: #section-read-graphai-hgraph}
+::: dgf.beam.io.read_graphai_hgraph
+
+## dgf.beam.io.read_spanner_graph  # {: #section-read-spanner-graph}
+::: dgf.beam.io.read_spanner_graph
+
+## dgf.beam.io.read_tfgnn_graphs  # {: #section-read-tfgnn-graphs}
+::: dgf.beam.io.read_tfgnn_graphs
+
+## dgf.beam.io.write_edge_set_to_spanner  # {: #section-write-edge-set-to-spanner}
+::: dgf.beam.io.write_edge_set_to_spanner
+
+## dgf.beam.io.write_feature_statistics  # {: #section-write-feature-statistics}
+::: dgf.beam.io.write_feature_statistics
+
+## dgf.beam.io.write_graph  # {: #section-write-graph}
+::: dgf.beam.io.write_graph
+
+## dgf.beam.io.write_graphai_hgraph  # {: #section-write-graphai-hgraph}
+::: dgf.beam.io.write_graphai_hgraph
+
+## dgf.beam.io.write_node_set_to_spanner  # {: #section-write-node-set-to-spanner}
+::: dgf.beam.io.write_node_set_to_spanner
+
+## dgf.beam.io.write_spanner  # {: #section-write-spanner}
+::: dgf.beam.io.write_spanner
+
+## dgf.beam.io.write_tfgnn_graphs  # {: #section-write-tfgnn-graphs}
+::: dgf.beam.io.write_tfgnn_graphs
+

doc/docs/api/dgf-beam-sampling.md

@@ -0,0 +1,16 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam.sampling
+
+## dgf.beam.sampling.extract_nodes_ids  # {: #section-extract-nodes-ids}
+::: dgf.beam.sampling.extract_nodes_ids
+
+## dgf.beam.sampling.semi_distributed_sampler_v1  # {: #section-semi-distributed-sampler-v1}
+::: dgf.beam.sampling.semi_distributed_sampler_v1
+
+## dgf.beam.sampling.semi_distributed_sampler_v2  # {: #section-semi-distributed-sampler-v2}
+::: dgf.beam.sampling.semi_distributed_sampler_v2
+

doc/docs/api/dgf-beam-transform.md

@@ -0,0 +1,10 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam.transform
+
+## dgf.beam.transform.reverse_edges  # {: #section-reverse-edges}
+::: dgf.beam.transform.reverse_edges
+

doc/docs/api/dgf-beam.md

@@ -0,0 +1,16 @@
+---
+hide:
+  - toc
+---
+
+# dgf.beam
+
+## dgf.beam.program_started  # {: #section-program-started}
+::: dgf.beam.program_started
+
+## dgf.beam.runner_from_name  # {: #section-runner-from-name}
+::: dgf.beam.runner_from_name
+
+## dgf.beam.runner_from_options  # {: #section-runner-from-options}
+::: dgf.beam.runner_from_options
+

doc/docs/api/dgf-convert.md

@@ -0,0 +1,61 @@
+---
+hide:
+  - toc
+---
+
+# dgf.convert
+
+## dgf.convert.graph_dict_to_graph  # {: #section-graph-dict-to-graph}
+::: dgf.convert.graph_dict_to_graph
+
+## dgf.convert.graph_to_jax_graph  # {: #section-graph-to-jax-graph}
+::: dgf.convert.graph_to_jax_graph
+
+## dgf.convert.graph_to_networkx  # {: #section-graph-to-networkx}
+::: dgf.convert.graph_to_networkx
+
+## dgf.convert.graph_to_serialized_tfgnn_graph  # {: #section-graph-to-serialized-tfgnn-graph}
+::: dgf.convert.graph_to_serialized_tfgnn_graph
+
+## dgf.convert.graph_to_sparse_deferred_struct  # {: #section-graph-to-sparse-deferred-struct}
+::: dgf.convert.graph_to_sparse_deferred_struct
+
+## dgf.convert.graph_to_tf_graph  # {: #section-graph-to-tf-graph}
+::: dgf.convert.graph_to_tf_graph
+
+## dgf.convert.graph_to_tfgnn_graph  # {: #section-graph-to-tfgnn-graph}
+::: dgf.convert.graph_to_tfgnn_graph
+
+## dgf.convert.graph_to_tfgnn_graph_dict  # {: #section-graph-to-tfgnn-graph-dict}
+::: dgf.convert.graph_to_tfgnn_graph_dict
+
+## dgf.convert.graphs_to_serialized_tfgnn_graphs  # {: #section-graphs-to-serialized-tfgnn-graphs}
+::: dgf.convert.graphs_to_serialized_tfgnn_graphs
+
+## dgf.convert.networkx_to_graph  # {: #section-networkx-to-graph}
+::: dgf.convert.networkx_to_graph
+
+## dgf.convert.schema_to_spanner_ddl  # {: #section-schema-to-spanner-ddl}
+::: dgf.convert.schema_to_spanner_ddl
+
+## dgf.convert.schema_to_sparse_deferred_schema  # {: #section-schema-to-sparse-deferred-schema}
+::: dgf.convert.schema_to_sparse_deferred_schema
+
+## dgf.convert.schema_to_tfgnn_schema  # {: #section-schema-to-tfgnn-schema}
+::: dgf.convert.schema_to_tfgnn_schema
+
+## dgf.convert.sparse_deferred_struct_to_graph  # {: #section-sparse-deferred-struct-to-graph}
+::: dgf.convert.sparse_deferred_struct_to_graph
+
+## dgf.convert.tf_graph_dict_to_tf_graph  # {: #section-tf-graph-dict-to-tf-graph}
+::: dgf.convert.tf_graph_dict_to_tf_graph
+
+## dgf.convert.tf_graph_to_tf_graph_dict  # {: #section-tf-graph-to-tf-graph-dict}
+::: dgf.convert.tf_graph_to_tf_graph_dict
+
+## dgf.convert.tfgnn_graph_to_graph  # {: #section-tfgnn-graph-to-graph}
+::: dgf.convert.tfgnn_graph_to_graph
+
+## dgf.convert.tfgnn_schema_to_schema  # {: #section-tfgnn-schema-to-schema}
+::: dgf.convert.tfgnn_schema_to_schema
+

doc/docs/api/dgf-data.md

@@ -0,0 +1,76 @@
+---
+hide:
+  - toc
+---
+
+# dgf.data
+
+## dgf.data.EdgeSchema  # {: #section-edgeschema}
+::: dgf.data.EdgeSchema
+
+## dgf.data.EdgeSetPadding  # {: #section-edgesetpadding}
+::: dgf.data.EdgeSetPadding
+
+## dgf.data.FeatureFormat  # {: #section-featureformat}
+::: dgf.data.FeatureFormat
+
+## dgf.data.FeatureSchema  # {: #section-featureschema}
+::: dgf.data.FeatureSchema
+
+## dgf.data.FeatureSemantic  # {: #section-featuresemantic}
+::: dgf.data.FeatureSemantic
+
+## dgf.data.FeatureSetStatistics  # {: #section-featuresetstatistics}
+::: dgf.data.FeatureSetStatistics
+
+## dgf.data.FeatureStatistics  # {: #section-featurestatistics}
+::: dgf.data.FeatureStatistics
+
+## dgf.data.GraphFeatureStatistics  # {: #section-graphfeaturestatistics}
+::: dgf.data.GraphFeatureStatistics
+
+## dgf.data.GraphSchema  # {: #section-graphschema}
+::: dgf.data.GraphSchema
+
+## dgf.data.GraphSchemaFilter  # {: #section-graphschemafilter}
+::: dgf.data.GraphSchemaFilter
+
+## dgf.data.GraphSchemaV2  # {: #section-graphschemav2}
+::: dgf.data.GraphSchemaV2
+
+## dgf.data.InMemoryEdgeSet  # {: #section-inmemoryedgeset}
+::: dgf.data.InMemoryEdgeSet
+
+## dgf.data.InMemoryGraph  # {: #section-inmemorygraph}
+::: dgf.data.InMemoryGraph
+
+## dgf.data.InMemoryNodeSet  # {: #section-inmemorynodeset}
+::: dgf.data.InMemoryNodeSet
+
+## dgf.data.JaxInMemoryEdgeSet  # {: #section-jaxinmemoryedgeset}
+::: dgf.data.JaxInMemoryEdgeSet
+
+## dgf.data.JaxInMemoryGraph  # {: #section-jaxinmemorygraph}
+::: dgf.data.JaxInMemoryGraph
+
+## dgf.data.JaxInMemoryNodeSet  # {: #section-jaxinmemorynodeset}
+::: dgf.data.JaxInMemoryNodeSet
+
+## dgf.data.NodeSchema  # {: #section-nodeschema}
+::: dgf.data.NodeSchema
+
+## dgf.data.NodeSetPadding  # {: #section-nodesetpadding}
+::: dgf.data.NodeSetPadding
+
+## dgf.data.Padding  # {: #section-padding}
+::: dgf.data.Padding
+
+## dgf.data.TFInMemoryEdgeSet  # {: #section-tfinmemoryedgeset}
+::: dgf.data.TFInMemoryEdgeSet
+
+## dgf.data.TFInMemoryGraph  # {: #section-tfinmemorygraph}
+::: dgf.data.TFInMemoryGraph
+
+## dgf.data.TFInMemoryNodeSet  # {: #section-tfinmemorynodeset}
+::: dgf.data.TFInMemoryNodeSet
+

doc/docs/api/dgf-exception.md

@@ -0,0 +1,10 @@
+---
+hide:
+  - toc
+---
+
+# dgf.exception
+
+## dgf.exception.InsufficientPaddingError  # {: #section-insufficientpaddingerror}
+::: dgf.exception.InsufficientPaddingError
+

doc/docs/api/dgf-filesystem.md

@@ -0,0 +1,34 @@
+---
+hide:
+  - toc
+---
+
+# dgf.filesystem
+
+## dgf.filesystem.create_gcs_bucket  # {: #section-create-gcs-bucket}
+::: dgf.filesystem.create_gcs_bucket
+
+## dgf.filesystem.exists  # {: #section-exists}
+::: dgf.filesystem.exists
+
+## dgf.filesystem.glob  # {: #section-glob}
+::: dgf.filesystem.glob
+
+## dgf.filesystem.is_gcs_path  # {: #section-is-gcs-path}
+::: dgf.filesystem.is_gcs_path
+
+## dgf.filesystem.makedirs  # {: #section-makedirs}
+::: dgf.filesystem.makedirs
+
+## dgf.filesystem.open_read  # {: #section-open-read}
+::: dgf.filesystem.open_read
+
+## dgf.filesystem.remove_paths  # {: #section-remove-paths}
+::: dgf.filesystem.remove_paths
+
+## dgf.filesystem.rename  # {: #section-rename}
+::: dgf.filesystem.rename
+
+## dgf.filesystem.rmtree  # {: #section-rmtree}
+::: dgf.filesystem.rmtree
+

doc/docs/api/dgf-generate.md

@@ -0,0 +1,25 @@
+---
+hide:
+  - toc
+---
+
+# dgf.generate
+
+## dgf.generate.EdgeNeighborGenerator  # {: #section-edgeneighborgenerator}
+::: dgf.generate.EdgeNeighborGenerator
+
+## dgf.generate.RandomNegativeSampler  # {: #section-randomnegativesampler}
+::: dgf.generate.RandomNegativeSampler
+
+## dgf.generate.RandomWalkNegativeSampler  # {: #section-randomwalknegativesampler}
+::: dgf.generate.RandomWalkNegativeSampler
+
+## dgf.generate.SyntheticGraphSampleConfig  # {: #section-syntheticgraphsampleconfig}
+::: dgf.generate.SyntheticGraphSampleConfig
+
+## dgf.generate.generate_synthetic_graph_sample  # {: #section-generate-synthetic-graph-sample}
+::: dgf.generate.generate_synthetic_graph_sample
+
+## dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs  # {: #section-write-synthetic-graph-sample-as-tfgnn-graphs}
+::: dgf.generate.write_synthetic_graph_sample_as_tfgnn_graphs
+