API docs (#379)

Browse Source

* Move API documentation into separate directory

* Rearrange main docs bar

* Split python examples into separate page

* Fix broken links

* Adds page for browseable API

* Fix image links

* Add entrypoint page for barcodes

* Update barcode docs

* Add (empty) pages for internal and external barcods

* Add documentation on "internal" barcode format

* Documentation for external barcode functionality

* Skeleton page for custom barcode information

* Extend docs for custom barcodesplugins

* Add stubs for new API docs

* Add documentation for downloading data via the AP

* API metadata information

* docs for pythonic metadata access

* docs for bulk delete

...

This commit is contained in:

Oliver

2022-10-29 14:46:06 +11:00

committed by GitHub

parent 415accae21

commit 48baf7e051

30 changed files with 572 additions and 148 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

docs

api

api.mdbrowse.mdbulk_delete.mddownload.mdmetadata.md

python

examples.mdpython.md

app

app.md

assets

images

api

api_browse.pngapi_category_options.pngapi_detail.pngapi_english.pngapi_filters.pngapi_german.pngapi_metadata_fields.png

barcode

barcode_link_1.pngbarcode_link_2.pngbarcode_no_match.pngbarcode_scan.pngbarcode_settings.pngbarcode_unlink.png

barcodes

barcodes.mdcustom.mdexternal.mdinternal.md

features.md

part

create.md

releases

0.1.7.md

stock

test.md

mkdocs.yml

BIN

docs/assets/images/api/api_browse.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 291 KiB

BIN

docs/assets/images/api/api_category_options.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 117 KiB

BIN

docs/assets/images/api/api_detail.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 197 KiB

BIN

docs/assets/images/api/api_english.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 138 KiB

BIN

docs/assets/images/api/api_filters.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 250 KiB

BIN

docs/assets/images/api/api_german.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 150 KiB

BIN

docs/assets/images/api/api_metadata_fields.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 64 KiB

BIN

docs/assets/images/barcode/barcode_link_1.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 223 KiB

BIN

docs/assets/images/barcode/barcode_link_2.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 41 KiB

BIN

docs/assets/images/barcode/barcode_no_match.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 49 KiB

BIN

docs/assets/images/barcode/barcode_scan.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 53 KiB

BIN

docs/assets/images/barcode/barcode_settings.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 100 KiB

BIN

docs/assets/images/barcode/barcode_unlink.png Normal file

Binary file not shown.

Side by Side After (image error) Size: 194 KiB