Merge pull request #15 from MITLibraries/etd-420-publish-docs

Etd 420 publish docs
MITLibraries · Jan 10, 2022 · 9aead67 · 9aead67
2 parents 421e8cf + 2d72471
commit 9aead67
Show file tree

Hide file tree

Showing 96 changed files with 23,062 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -4,6 +4,8 @@ dspace-python-client
 
 A Python client library for working with the DSpace API. This was written against the `DSpace version 6.x API <https://wiki.lyrasis.org/display/DSDOC6x/REST+API>`_ and will not work with later versions of DSpace.
 
+See API documentation at `https://mitlibraries.github.io/dspace-python-client/ <https://mitlibraries.github.io/dspace-python-client/>`_.
+
 -----
 Usage
 -----
@@ -21,19 +23,19 @@ To authenticate the DSpace client::
   from dspace.bitstream import Bitstream
   from dspace.client import DSpaceClient
   from dspace.item import Item, MetadataEntry
-  
+
   client = DSpaceClient(<DSpace API URL>)
   client.login(<your email>, <your password>)
 
 To post an item and associated bitstream with an authenticated client::
-  
+
   title = MetadataEntry(key="dc.title", value="Test Item")
   item = Item(metadata=[title])
   item.post(client, collection_handle=<valid DSpace handle e.g. "1234.5/6789">)
 
   bitstream = Bitstream(name="test.txt", file_path="test.txt")
   bitstream.post(client, item_uuid=item.uuid)
-  
+
 
 ------------
 Development

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = html
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/html/doctrees/environment.pickle b/docs/html/doctrees/environment.pickle
diff --git a/docs/html/doctrees/index.doctree b/docs/html/doctrees/index.doctree
diff --git a/docs/html/doctrees/readme.doctree b/docs/html/doctrees/readme.doctree
diff --git a/docs/html/doctrees/source/dspace.doctree b/docs/html/doctrees/source/dspace.doctree
diff --git a/docs/html/doctrees/source/modules.doctree b/docs/html/doctrees/source/modules.doctree
diff --git a/docs/html/html/.buildinfo b/docs/html/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 70378f9a3640ecb8b78a9e3cb2e199ce
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/html/_sources/index.rst.txt b/docs/html/html/_sources/index.rst.txt
@@ -0,0 +1,29 @@
+.. dspace-python-client documentation master file, created by
+   sphinx-quickstart on Thu Aug 19 10:20:18 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+==================================
+dspace-python-client Documentation
+==================================
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   Getting Started <readme>
+   API Docs <source/modules>
+
+-------
+License
+-------
+
+The project is licensed under the Apache 2.0 license.
+
+==================
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/html/html/_sources/readme.rst.txt b/docs/html/html/_sources/readme.rst.txt
@@ -0,0 +1,3 @@
+.. contents:: :depth: 3
+
+.. include:: ../README.rst
diff --git a/docs/html/html/_sources/source/dspace.rst.txt b/docs/html/html/_sources/source/dspace.rst.txt
@@ -0,0 +1,53 @@
+dspace package
+==============
+
+Submodules
+----------
+
+dspace.bitstream module
+-----------------------
+
+.. automodule:: dspace.bitstream
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dspace.client module
+--------------------
+
+.. automodule:: dspace.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dspace.errors module
+--------------------
+
+.. automodule:: dspace.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dspace.item module
+------------------
+
+.. automodule:: dspace.item
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+dspace.utils module
+-------------------
+
+.. automodule:: dspace.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: dspace
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/html/_sources/source/modules.rst.txt b/docs/html/html/_sources/source/modules.rst.txt
@@ -0,0 +1,7 @@
+dspace
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   dspace