Skip to content
Snippets Groups Projects
Commit 9a0d792c authored by Yoann Schneider's avatar Yoann Schneider :tennis: Committed by Manon Blanco
Browse files

Simplify API references documentation options

parent aa0ef563
No related branches found
No related tags found
1 merge request!429Simplify API references documentation options
Pipeline #139984 passed
# Classification
::: arkindex_worker.worker.classification
options:
members: no
::: arkindex_worker.worker.classification.ClassificationMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# Dataset
::: arkindex_worker.worker.dataset
options:
members:
- DatasetState
options:
show_category_heading: no
::: arkindex_worker.worker.dataset.DatasetMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# Element
::: arkindex_worker.worker.element
options:
members:
- ElementType
- MissingTypeError
options:
show_category_heading: no
::: arkindex_worker.worker.element.ElementMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
\ No newline at end of file
# Entity
::: arkindex_worker.worker.entity
options:
members:
- MissingEntityType
options:
show_category_heading: no
::: arkindex_worker.worker.entity.EntityMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
\ No newline at end of file
# Metadata
::: arkindex_worker.worker.metadata
options:
members:
- MetaType
options:
show_category_heading: no
::: arkindex_worker.worker.metadata.MetaDataMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# Task
::: arkindex_worker.worker.task
options:
members: no
options:
show_category_heading: no
::: arkindex_worker.worker.task.TaskMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# Training
::: arkindex_worker.worker.training
options:
members:
- DirPath
- Hash
- FileSize
- create_archive
options:
show_category_heading: no
::: arkindex_worker.worker.training.TrainingMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# Transcription
::: arkindex_worker.worker.transcription
options:
members:
- TextOrientation
options:
show_category_heading: no
::: arkindex_worker.worker.transcription.TranscriptionMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
# WorkerVersion
::: arkindex_worker.worker.version
options:
members: no
options:
show_category_heading: no
::: arkindex_worker.worker.version.WorkerVersionMixin
options:
show_bases: false
show_category_heading: no
show_root_heading: no
\ No newline at end of file
......@@ -54,8 +54,10 @@ plugins:
docstring_style: sphinx
merge_init_into_class: yes
show_category_heading: yes
show_signature_annotations: yes
separate_signature: yes
members_order: source
unwrap_annotated: yes
nav:
- Home: index.md
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment