Simplify docs

Author: SeanDuHare

.github/workflows/docs.yml

@@ -68,11 +68,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-docs/bioio_sldy.*rst
-docs/modules.rst
-
 # PyBuilder
 target/
 

.gitignore

@@ -66,11 +66,9 @@ Available recipes:
     build                    # run lint and then run tests
     clean                    # clean all build, python, and lint files
     default                  # list all available commands
-    generate-docs            # generate Sphinx HTML documentation
     install                  # install with all deps
     lint                     # lint, format, and check all files
     release                  # release a new version
-    serve-docs               # generate Sphinx HTML documentation and serve to browser
     tag-for-release version  # tag a new version
     test                     # run tests
     update-from-cookiecutter # update this repo using latest cookiecutter-bioio-reader

CONTRIBUTING.md

@@ -5,7 +5,6 @@ default:
 # clean all build, python, and lint files
 clean:
 	rm -fr build
-	rm -fr docs/_build
 	rm -fr dist
 	rm -fr .eggs
 	find . -name '*.egg-info' -exec rm -fr {} +
@@ -22,7 +21,7 @@ clean:
 
 # install with all deps
 install:
-	pip install -e .[lint,test,docs]
+	pip install -e .[lint,test]
 	pre-commit install
 
 # install dependencies, setup pre-commit, download test resources
@@ -44,29 +43,6 @@ build:
 	just lint
 	just test
 
-# generate Sphinx HTML documentation
-generate-docs:
-	rm -f docs/bioio_sldy*.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -o docs bioio_sldy **/tests
-	python -msphinx "docs" "docs/_build"
-
-
-# Generate project URI for browser opening
-# We replace here to handle windows paths
-# Windows paths are normally `\` separated but even in the browser they use `/`
-# https://stackoverflow.com/a/61991869
-project_uri := if "os_family()" == "unix" {
-	justfile_directory()
-} else {
-	replace(justfile_directory(), "\\", "/")
-}
-
-# generate Sphinx HTML documentation and serve to browser
-serve-docs:
-	just generate-docs
-	python -mwebbrowser -t "file://{{project_uri}}/docs/_build/index.html"
-
 # tag a new version
 tag-for-release version:
 	git tag -a "{{version}}" -m "{{version}}"

Justfile

@@ -1,34 +1,50 @@
 # bioio-sldy
 
 [![Build Status](https://github.com/bioio-devs/bioio-sldy/actions/workflows/ci.yml/badge.svg)](https://github.com/bioio-devs/bioio-sldy/actions)
-[![Documentation](https://github.com/bioio-devs/bioio-sldy/actions/workflows/docs.yml/badge.svg)](https://bioio-devs.github.io/bioio-sldy)
+[![PyPI version](https://badge.fury.io/py/bioio-sldy.svg)](https://badge.fury.io/py/bioio-sldy)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9,3.10,3.11-blue.svg)](https://www.python.org/downloads/release/python-390/)
 
-A BioIO reader plugin for reading 3i slidebook (SLDY) images.
-
-This plugin is intended to be used in conjunction with [bioio](https://github.com/bioio-devs/bioio)
+A BioIO reader plugin for reading 3i Slidebook files
 
 ---
 
+
+## Documentation
+
+[See the full documentation on our GitHub pages site](https://bioio-devs.github.io/bioio/OVERVIEW.html) - the generic use and installation instructions there will work for this package.
+
+Information about the base reader this package relies on can be found in the `bioio-base` repository [here](https://github.com/bioio-devs/bioio-base)
+
 ## Installation
 
 **Stable Release:** `pip install bioio-sldy`<br>
 **Development Head:** `pip install git+https://github.com/bioio-devs/bioio-sldy.git`
 
-## Quickstart
+## Example Usage (see full documentation for more examples)
 
+Install bioio-sldy alongside bioio:
+
+`pip install bioio bioio-sldy`
+
+
+This example shows a simple use case for just accessing the pixel data of the image
+by explicitly passing this `Reader` into the `BioImage`. Passing the `Reader` into
+the `BioImage` instance is optional as `bioio` will automatically detect installed
+plug-ins and auto-select the most recently installed plug-in that supports the file
+passed in.
 ```python
-from bioio_sldy import Reader 
+from bioio import BioImage
+import bioio_sldy
 
-r = Reader("my-image.ext")
-r.dims
+img = BioImage("my_file.sld", reader=bioio_ome_tiff.Reader)
+img.data
 ```
 
-## Documentation
+## Issues
+[_Click here to view all open issues in bioio-devs organization at once_](https://github.com/search?q=user%3Abioio-devs+is%3Aissue+is%3Aopen&type=issues&ref=advsearch) or check this repository's issue tab.
 
-For full package documentation please visit [bioio-devs.github.io/bioio-sldy](https://bioio-devs.github.io/bioio-sldy).
 
 ## Development
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.
-
-**MIT License**