Skip to content

Commit

Permalink
Merge pull request #597 from bioimage-io/improve_docs
Browse files Browse the repository at this point in the history
remove user documentation links
  • Loading branch information
FynnBe authored May 15, 2024
2 parents 3a8787e + c8ce19e commit edaee50
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 14 deletions.
4 changes: 2 additions & 2 deletions bioimageio/spec/application/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- application v0_2: `bioimageio.spec.application.v0_2.ApplicationDescr` [user documentation](../../../user_docs/application_descr_v0-2.md)
- application v0_3: `bioimageio.spec.application.v0_3.ApplicationDescr` [user documentation](../../../user_docs/application_descr_v0-3.md)
- application v0_2: `bioimageio.spec.application.v0_2.ApplicationDescr`
- application v0_3: `bioimageio.spec.application.v0_3.ApplicationDescr`
"""
from typing import Union

Expand Down
4 changes: 2 additions & 2 deletions bioimageio/spec/collection/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- collection v0_2: `bioimageio.spec.collection.v0_2.CollectionDescr` [user documentation](../../../user_docs/collection_descr_v0-2.md)
- collection v0_3: `bioimageio.spec.collection.v0_3.CollectionDescr` [user documentation](../../../user_docs/collection_descr_v0-3.md)
- collection v0_2: `bioimageio.spec.collection.v0_2.CollectionDescr`
- collection v0_3: `bioimageio.spec.collection.v0_3.CollectionDescr`
"""
from typing import Union

Expand Down
4 changes: 2 additions & 2 deletions bioimageio/spec/dataset/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- dataset v0_2: `bioimageio.spec.dataset.v0_2.DatasetDescr` [user documentation](../../../user_docs/dataset_descr_v0-2.md)
- dataset v0_3: `bioimageio.spec.dataset.v0_3.DatasetDescr` [user documentation](../../../user_docs/dataset_descr_v0-3.md)
- dataset v0_2: `bioimageio.spec.dataset.v0_2.DatasetDescr`
- dataset v0_3: `bioimageio.spec.dataset.v0_3.DatasetDescr`
"""
from typing import Union

Expand Down
4 changes: 2 additions & 2 deletions bioimageio/spec/generic/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- generic v0_2: `bioimageio.spec.generic.v0_2.GenericDescr` [user documentation](../../../user_docs/generic_descr_v0-2.md)
- generic v0_3: `bioimageio.spec.generic.v0_3.GenericDescr` [user documentation](../../../user_docs/generic_descr_v0-3.md)
- generic v0_2: `bioimageio.spec.generic.v0_2.GenericDescr`
- generic v0_3: `bioimageio.spec.generic.v0_3.GenericDescr`
"""
from typing import Union

Expand Down
4 changes: 2 additions & 2 deletions bioimageio/spec/model/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- model v0_4: `bioimageio.spec.model.v0_4.ModelDescr` [user documentation](../../../user_docs/model_descr_v0-4.md)
- model v0_5: `bioimageio.spec.model.v0_5.ModelDescr` [user documentation](../../../user_docs/model_descr_v0-5.md)
- model v0_4: `bioimageio.spec.model.v0_4.ModelDescr`
- model v0_5: `bioimageio.spec.model.v0_5.ModelDescr`
"""
from typing import Union

Expand Down
4 changes: 2 additions & 2 deletions bioimageio/spec/notebook/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# autogen: start
"""
implementaions of all released minor versions are available in submodules:
- notebook v0_2: `bioimageio.spec.notebook.v0_2.NotebookDescr` [user documentation](../../../user_docs/notebook_descr_v0-2.md)
- notebook v0_3: `bioimageio.spec.notebook.v0_3.NotebookDescr` [user documentation](../../../user_docs/notebook_descr_v0-3.md)
- notebook v0_2: `bioimageio.spec.notebook.v0_2.NotebookDescr`
- notebook v0_3: `bioimageio.spec.notebook.v0_3.NotebookDescr`
"""
from typing import Union

Expand Down
3 changes: 1 addition & 2 deletions scripts/generate_version_submodule_imports.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,7 @@ def __post_init__(self):
self.submodule_list = "\n".join(
[
f"- {self.target} {vm}: `bioimageio.spec.{self.target}.{vm}."
+ f"{self.target_node}` [user documentation](../../../user_docs/"
+ f"{self.target}_descr_{vm.replace('_', '-')}.md)"
+ f"{self.target_node}`"
for vm in self.all_version_modules
]
)
Expand Down

0 comments on commit edaee50

Please sign in to comment.