diff --git a/docs/source/cmdline/dandi.rst b/docs/source/cmdline/dandi.rst index b92167d16..a0f792b70 100644 --- a/docs/source/cmdline/dandi.rst +++ b/docs/source/cmdline/dandi.rst @@ -1,12 +1,12 @@ :program:`lincbrain` -================ +==================== :: lincbrain [] [] -A command-line client for interacting with the `DANDI Archive -`_. +A command-line client for interacting with the `LINC Data Platform +`_. Global Options -------------- diff --git a/docs/source/cmdline/delete.rst b/docs/source/cmdline/delete.rst index dbb854353..9fceae2a1 100644 --- a/docs/source/cmdline/delete.rst +++ b/docs/source/cmdline/delete.rst @@ -1,5 +1,5 @@ :program:`lincbrain delete` -======================= +=========================== :: diff --git a/docs/source/cmdline/digest.rst b/docs/source/cmdline/digest.rst index c3c79bc3f..9742c2157 100644 --- a/docs/source/cmdline/digest.rst +++ b/docs/source/cmdline/digest.rst @@ -1,5 +1,5 @@ :program:`lincbrain digest` -======================= +=========================== :: diff --git a/docs/source/cmdline/download.rst b/docs/source/cmdline/download.rst index 38822b553..b2b6855a3 100644 --- a/docs/source/cmdline/download.rst +++ b/docs/source/cmdline/download.rst @@ -1,5 +1,5 @@ :program:`lincbrain download` -========================= +============================= :: diff --git a/docs/source/cmdline/index.rst b/docs/source/cmdline/index.rst index eeae5f58d..c20099927 100644 --- a/docs/source/cmdline/index.rst +++ b/docs/source/cmdline/index.rst @@ -7,5 +7,5 @@ Command-Line Interface .. toctree:: :glob: - dandi + lincbrain * diff --git a/docs/source/cmdline/instances.rst b/docs/source/cmdline/instances.rst index 032d97525..b79c635b9 100644 --- a/docs/source/cmdline/instances.rst +++ b/docs/source/cmdline/instances.rst @@ -1,11 +1,11 @@ :program:`lincbrain instances` -========================== +============================== :: lincbrain [] instances -List known Dandi Archive instances that can be passed to the +List known LINC Archive instances that can be passed to the ``-i``/``--dandi-instance`` option of other subcommands for the CLI to interact with. Output is in YAML. diff --git a/docs/source/cmdline/ls.rst b/docs/source/cmdline/ls.rst index c396fec37..aeddab34f 100644 --- a/docs/source/cmdline/ls.rst +++ b/docs/source/cmdline/ls.rst @@ -1,5 +1,5 @@ :program:`lincbrain ls` -=================== +======================= :: diff --git a/docs/source/cmdline/move.rst b/docs/source/cmdline/move.rst index 0310e32ba..dc3e40808 100644 --- a/docs/source/cmdline/move.rst +++ b/docs/source/cmdline/move.rst @@ -1,5 +1,5 @@ :program:`lincbrain move` -===================== +========================= :: diff --git a/docs/source/cmdline/organize.rst b/docs/source/cmdline/organize.rst index 97962d4a3..06a3d000b 100644 --- a/docs/source/cmdline/organize.rst +++ b/docs/source/cmdline/organize.rst @@ -1,7 +1,7 @@ .. _dandi_organize: :program:`lincbrain organize` -========================= +============================= :: diff --git a/docs/source/cmdline/service-scripts.rst b/docs/source/cmdline/service-scripts.rst index 7017aa007..0c9f113ad 100644 --- a/docs/source/cmdline/service-scripts.rst +++ b/docs/source/cmdline/service-scripts.rst @@ -1,5 +1,5 @@ :program:`lincbrain service-scripts` -================================ +==================================== :: diff --git a/docs/source/cmdline/shell-completion.rst b/docs/source/cmdline/shell-completion.rst index b90a49210..2d75ea9ed 100644 --- a/docs/source/cmdline/shell-completion.rst +++ b/docs/source/cmdline/shell-completion.rst @@ -1,5 +1,5 @@ :program:`lincbrain shell-completion` -================================= +===================================== :: diff --git a/docs/source/cmdline/upload.rst b/docs/source/cmdline/upload.rst index d58478ce1..183615946 100644 --- a/docs/source/cmdline/upload.rst +++ b/docs/source/cmdline/upload.rst @@ -1,5 +1,5 @@ :program:`lincbrain upload` -======================= +=========================== :: diff --git a/docs/source/cmdline/validate.rst b/docs/source/cmdline/validate.rst index 111ccd441..e9b6ed618 100644 --- a/docs/source/cmdline/validate.rst +++ b/docs/source/cmdline/validate.rst @@ -1,5 +1,5 @@ -:program:`dandi validate` -========================= +:program:`lincbrain validate` +============================= :: diff --git a/docs/source/modref/consts.rst b/docs/source/modref/consts.rst index 988d3f68c..a83ece87a 100644 --- a/docs/source/modref/consts.rst +++ b/docs/source/modref/consts.rst @@ -1,7 +1,7 @@ ``dandi.consts`` ================ -.. automodule:: dandi.consts +.. automodule:: lincbrain.consts .. NOTE: Due to , only data values with doc comments are included by automodule::, even with diff --git a/docs/source/modref/dandiapi.rst b/docs/source/modref/dandiapi.rst index a74bf5c89..f0b81705f 100644 --- a/docs/source/modref/dandiapi.rst +++ b/docs/source/modref/dandiapi.rst @@ -1,9 +1,9 @@ -.. module:: dandi.dandiapi +.. module:: lincbrain.dandiapi ``dandi.dandiapi`` ================== -This module provides functionality for interacting with a Dandi Archive server +This module provides functionality for interacting with a LINC Data Platform server via the REST API. Interaction begins with the creation of a `DandiAPIClient` instance, which can be used to retrieve `RemoteDandiset` objects (representing Dandisets on the server) and `BaseRemoteAsset` objects (representing assets diff --git a/docs/source/modref/dandiarchive.rst b/docs/source/modref/dandiarchive.rst index 4b97bd9ff..99359ed91 100644 --- a/docs/source/modref/dandiarchive.rst +++ b/docs/source/modref/dandiarchive.rst @@ -1,6 +1,6 @@ ``dandi.dandiarchive`` ====================== -.. automodule:: dandi.dandiarchive +.. automodule:: lincbrain.dandiarchive :member-order: bysource :show-inheritance: diff --git a/docs/source/modref/files.rst b/docs/source/modref/files.rst index c5a9abe77..c2d892632 100644 --- a/docs/source/modref/files.rst +++ b/docs/source/modref/files.rst @@ -1,5 +1,5 @@ ``dandi.files`` =============== -.. automodule:: dandi.files +.. automodule:: lincbrain.files :show-inheritance: diff --git a/docs/source/modref/index.rst b/docs/source/modref/index.rst index 15b280b75..1dd4b19c7 100644 --- a/docs/source/modref/index.rst +++ b/docs/source/modref/index.rst @@ -1,7 +1,7 @@ .. -*- mode: rst -*- .. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79: -.. currentmodule:: dandi +.. currentmodule:: lincbrain .. _chap_modref: diff --git a/docs/source/modref/misctypes.rst b/docs/source/modref/misctypes.rst index d1ee6a0b1..366491796 100644 --- a/docs/source/modref/misctypes.rst +++ b/docs/source/modref/misctypes.rst @@ -1,4 +1,4 @@ ``dandi.misctypes`` =================== -.. automodule:: dandi.misctypes +.. automodule:: lincbrain.misctypes diff --git a/docs/source/modref/support.digests.rst b/docs/source/modref/support.digests.rst index c758c2084..98291ba6b 100644 --- a/docs/source/modref/support.digests.rst +++ b/docs/source/modref/support.digests.rst @@ -1,4 +1,4 @@ ``dandi.support.digests`` ========================= -.. automodule:: dandi.support.digests +.. automodule:: lincbrain.support.digests diff --git a/docs/source/modref/utils.rst b/docs/source/modref/utils.rst index 604dd0d69..11fa65385 100644 --- a/docs/source/modref/utils.rst +++ b/docs/source/modref/utils.rst @@ -1,4 +1,4 @@ ``dandi.utils`` =============== -.. automodule:: dandi.utils +.. automodule:: lincbrain.utils