Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Clean up for readthedocs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaron Kanzer authored and Aaron Kanzer committed Jul 24, 2024
1 parent 192a976 commit 3b07071
Show file tree
Hide file tree
Showing 21 changed files with 26 additions and 26 deletions.
6 changes: 3 additions & 3 deletions docs/source/cmdline/dandi.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:program:`lincbrain`
================
====================

::

lincbrain [<global options>] <subcommand> [<arguments>]

A command-line client for interacting with the `DANDI Archive
<http://dandiarchive.org>`_.
A command-line client for interacting with the `LINC Data Platform
<http://lincbrain.org>`_.

Global Options
--------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/delete.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain delete`
=======================
===========================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/digest.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain digest`
=======================
===========================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/download.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain download`
=========================
=============================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Command-Line Interface
.. toctree::
:glob:

dandi
lincbrain
*
4 changes: 2 additions & 2 deletions docs/source/cmdline/instances.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
:program:`lincbrain instances`
==========================
==============================

::

lincbrain [<global options>] 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/ls.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain ls`
===================
=======================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/move.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain move`
=====================
=========================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/organize.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dandi_organize:

:program:`lincbrain organize`
=========================
=============================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/service-scripts.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain service-scripts`
================================
====================================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/shell-completion.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain shell-completion`
=================================
=====================================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cmdline/upload.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`lincbrain upload`
=======================
===========================

::

Expand Down
4 changes: 2 additions & 2 deletions docs/source/cmdline/validate.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:program:`dandi validate`
=========================
:program:`lincbrain validate`
=============================

::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modref/consts.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
``dandi.consts``
================

.. automodule:: dandi.consts
.. automodule:: lincbrain.consts

.. NOTE: Due to <https://github.com/sphinx-doc/sphinx/issues/1063>, only
data values with doc comments are included by automodule::, even with
Expand Down
4 changes: 2 additions & 2 deletions docs/source/modref/dandiapi.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modref/dandiarchive.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
``dandi.dandiarchive``
======================

.. automodule:: dandi.dandiarchive
.. automodule:: lincbrain.dandiarchive
:member-order: bysource
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/source/modref/files.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
``dandi.files``
===============

.. automodule:: dandi.files
.. automodule:: lincbrain.files
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/source/modref/index.rst
Original file line number Diff line number Diff line change
@@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/modref/misctypes.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
``dandi.misctypes``
===================

.. automodule:: dandi.misctypes
.. automodule:: lincbrain.misctypes
2 changes: 1 addition & 1 deletion docs/source/modref/support.digests.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
``dandi.support.digests``
=========================

.. automodule:: dandi.support.digests
.. automodule:: lincbrain.support.digests
2 changes: 1 addition & 1 deletion docs/source/modref/utils.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
``dandi.utils``
===============

.. automodule:: dandi.utils
.. automodule:: lincbrain.utils

0 comments on commit 3b07071

Please sign in to comment.