Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recategorize API reference #663

Merged
merged 3 commits into from
Oct 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 101 additions & 114 deletions docs/_quarto.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,101 +22,94 @@ website:
style: "floating"
collapse-level: 1
contents:
- Cloud-Py
- section: Cloud Services
- section: Catalog
contents:
- text: "`array`"
- text: groups
href: reference/groups.qmd
- text: array
href: reference/array.qmd
- text: "`asset`"
- text: asset
href: reference/asset.qmd
- text: "`client`"
href: reference/client.qmd
- text: "`cloudarray`"
href: reference/cloudarray.qmd
- text: "`config`"
href: reference/config.qmd
- text: "`groups`"
href: reference/groups.qmd
- text: "`invites`"
href: reference/invites.qmd
- text: "`notebook`"
- text: files
href: reference/files.qmd
- text: notebook
href: reference/notebook.qmd
- text: "`pool_manager_wrapper`"
href: reference/pool_manager_wrapper.qmd
- text: "`tasks`"
href: reference/tasks.qmd
- text: "`tiledb_cloud_error`"
href: reference/tiledb_cloud_error.qmd
- text: "`udf`"
- text: udf
href: reference/udf.qmd
- text: "`utils`"
href: reference/utils.qmd
- section: Bio-Imaging

- section: Collaborate
contents:
- text: groups
href: reference/groups.qmd
- text: array
href: reference/array.qmd
- text: asset
href: reference/asset.qmd
- text: invites
href: reference/invites.qmd

- section: Analyze
contents:
- text: "`exportation`"
- text: bioimg.exportation
href: reference/bioimg.exportation.qmd
- text: "`helpers`"
- text: bioimg.helpers
href: reference/bioimg.helpers.qmd
- text: "`ingestion`"
- text: bioimg.ingestion
href: reference/bioimg.ingestion.qmd
- section: Compute
contents:
- text: "`delayed`"
href: reference/compute.delayed.qmd
- section: DAG
contents:
- text: "`dag`"
href: reference/dag.dag.qmd
- text: "`mode`"
href: reference/dag.mode.qmd
- text: "`status`"
href: reference/dag.status.qmd
- text: "`visualization`"
href: reference/dag.visualization.qmd
- section: Region
contents:
- text: "`region`"
href: reference/region.qmd
- section: Files
contents:
- text: "`indexing`"
- text: files.indexing
href: reference/files.indexing.qmd
- text: "`ingestion`"
- text: files.ingestion
href: reference/files.ingestion.qmd
- text: "`udfs`"
- text: files.udfs
href: reference/files.udfs.qmd
- text: "`utils`"
- text: files.utils
href: reference/files.utils.qmd
- section: Geospatial
contents:
- text: "`ingestion`"
- text: geospatial.ingestion
href: reference/geospatial.ingestion.qmd
- section: SOMA
contents:
- text: "`ingest`"
- text: soma.ingest
href: reference/soma.ingest.qmd
- text: "`mapper`"
- text: soma.mapper
href: reference/soma.mapper.qmd
- section: VCF
contents:
- text: "`allele_frequency`"
- text: vcf.allele_frequency
href: reference/vcf.allele_frequency.qmd
- text: "`ingestion`"
- text: vcf.ingestionq
href: reference/vcf.ingestion.qmd
- text: "`query`"
- text: vcf.query
href: reference/vcf.query.qmd
- text: "`utils`"
- text: vcf.utils
href: reference/vcf.utils.qmd
- text: "`split`"
- text: vcf.split
href: reference/vcf.split.qmd
- section: Utilities

- section: Scale
contents:
- text: "`consolidate`"
- text: cloudarray
href: reference/cloudarray.qmd
- text: compute.delayed
href: reference/compute.delayed.qmd
- text: dag.dag
href: reference/dag.dag.qmd
- text: dag.mode
href: reference/dag.mode.qmd
- text: dag.status
href: reference/dag.status.qmd
- text: dag.visualization
href: reference/dag.visualization.qmd
- text: tasks
href: reference/tasks.qmd
- text: udf
href: reference/udf.qmd
- text: utilities.consolidate
href: reference/utilities.consolidate.qmd
- text: "`profiler`"
- text: utilities.profiler
href: reference/utilities.profiler.qmd
- text: "`wheel`"
href: reference/utilities.wheel.qmd

- section: Account
contents:
- text: client
href: reference/client.qmd
- text: config
href: reference/config.qmd

quartodoc:
style: pkgdown
Expand All @@ -130,79 +123,73 @@ quartodoc:
include_attributes: true

sections:
- title: Cloud Services
desc: Cloud Interaction Services
- title: Catalog
desc: "Find and register private and public assets."
sgillies marked this conversation as resolved.
Show resolved Hide resolved
contents:
- groups
- array
- asset
- client
- cloudarray
- config
- groups
- invites
- files
- notebook
- pool_manager_wrapper
- tasks
- tiledb_cloud_error
- udf
- utils

- title: bioimg
desc: Bio imaging API
- title: Collaborate
desc: "Share private assets with other users and organizations, or make them public."
contents:
- bioimg.exportation
- bioimg.helpers
- bioimg.ingestion
- groups
- array
- asset
- invites

- title: compute
desc: Compute API
contents:
- compute.delayed
- title: Analyze
desc: "Gain understanding of data."

- title: dag
desc: DAG API
- subtitle: Bio Imaging
contents:
- dag.dag
- dag.mode
- dag.status
- dag.visualization

- title: region
desc: Cloud regions
contents:
- region
- bioimg.exportation
- bioimg.helpers
- bioimg.ingestion

- title: files
desc: File API.
- subtitle: Files
contents:
- files.indexing
- files.ingestion
- files.udfs
- files.utils

- title: geospatial
desc: Geospatial API
- subtitle: Geospatial
contents:
- geospatial.ingestion

- title: soma
desc: SOMA API
- subtitle: SOMA
contents:
- soma.ingest
- soma.mapper

- title: vcf
desc: VCF API
- subtitle: VCF
contents:
- vcf.allele_frequency
- vcf.ingestion
- vcf.query
- vcf.utils
- vcf.split
- vcf.utils

- title: utilities
desc: Common Utilities API
- title: Scale
desc: "Ingest and analyze data that is too large for a single computer."
contents:
- cloudarray
- compute.delayed
- dag.dag
- dag.mode
- dag.status
- dag.visualization
- tasks
- udf
- utilities.consolidate
- utilities.profiler
- utilities.wheel

- title: Account
desc: "Profile, settings, and usage."
contents:
- client
- config
Loading