Merge pull request #162 from iolanta-tech/document-more-types

Document the types
iolanta-tech · Jul 13, 2024 · 3797f5f · 3797f5f
2 parents 70cce3c + b1c99bc
commit 3797f5f
Show file tree

Hide file tree

Showing 14 changed files with 64 additions and 5 deletions.
diff --git a/docs/types/document-loader-options.md b/docs/types/document-loader-options.md
@@ -0,0 +1,6 @@
+---
+title: DocumentLoaderOptions
+hide: [toc]
+---
+
+::: yaml_ld.document_loaders.base.DocumentLoaderOptions
diff --git a/docs/types/loaders/base.md b/docs/types/loaders/base.md
@@ -0,0 +1,6 @@
+---
+title: Base
+hide: [toc]
+---
+
+::: yaml_ld.document_loaders.base.DocumentLoader
diff --git a/docs/types/loaders/choice-by-scheme.md b/docs/types/loaders/choice-by-scheme.md
@@ -0,0 +1,6 @@
+---
+title: ChoiceBySchemeDocumentLoader
+hide: [toc]
+---
+
+::: yaml_ld.document_loaders.choice_by_scheme.ChoiceBySchemeDocumentLoader
diff --git a/docs/types/loaders/http.md b/docs/types/loaders/http.md
@@ -0,0 +1,6 @@
+---
+title: HTTP
+hide: [toc]
+---
+
+::: yaml_ld.document_loaders.http.HTTPDocumentLoader
diff --git a/docs/types/loaders/index.md b/docs/types/loaders/index.md
@@ -0,0 +1 @@
+::: yaml_ld.document_loaders.default.DEFAULT_DOCUMENT_LOADER
diff --git a/docs/types/loaders/local-file.md b/docs/types/loaders/local-file.md
@@ -0,0 +1,6 @@
+---
+title: Local File
+hide: [toc]
+---
+
+::: yaml_ld.document_loaders.local_file.LocalFileDocumentLoader
diff --git a/docs/types/parsers/base.md b/docs/types/parsers/base.md
@@ -0,0 +1,6 @@
+---
+title: Base
+hide: [toc]
+---
+
+::: yaml_ld.document_parsers.base.BaseDocumentParser
diff --git a/docs/types/parsers/html.md b/docs/types/parsers/html.md
@@ -0,0 +1,6 @@
+---
+title: HTML
+hide: [toc]
+---
+
+::: yaml_ld.document_parsers.html_parser.HTMLDocumentParser
diff --git a/docs/types/parsers/rdf-xml.md b/docs/types/parsers/rdf-xml.md
@@ -0,0 +1,6 @@
+---
+title: RDF/XML
+hide: [toc]
+---
+
+::: yaml_ld.document_parsers.rdf_xml_parser.RDFXMLParser
diff --git a/docs/types/parsers/yaml.md b/docs/types/parsers/yaml.md
@@ -0,0 +1,6 @@
+---
+title: YAML-LD/JSON-LD
+hide: [toc]
+---
+
+::: yaml_ld.document_parsers.yaml_parser.YAMLDocumentParser
diff --git a/docs/types/path.md → docs/types/third-party/path.md b/docs/types/path.md → docs/types/third-party/path.md
diff --git a/docs/types/url.md → docs/types/third-party/url.md b/docs/types/url.md → docs/types/third-party/url.md
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,4 +1,5 @@
 import json
+import os
 
 import pytest
 from pydantic import ValidationError
@@ -29,6 +30,9 @@ def _url_to_id(url: URL) -> str:
 
 @pytest.fixture(params=URLS, ids=_url_to_id)
 def url(request) -> URL:
+    if os.environ.get('CI'):
+        pytest.skip('This test is long and unreliable, skipping it in CI.')
+
     yaml_ld.load_document(request.param)
     return request.param
 

diff --git a/yaml_ld/cli/app.py b/yaml_ld/cli/app.py
@@ -182,14 +182,14 @@ def get(
 @cli.command()
 @funcy.post_processing(console.print)
 def compact(   # noqa: WPS211
-    ctx: Annotated[
-        str,
-        Option(help='Context to compact with.'),
-    ],
     input_: Annotated[
         MaybeStr,
         Argument(help='Path or URL. Omit to read from standard input.'),
     ] = None,
+    ctx: Annotated[
+        MaybeStr,
+        Option(help='Context to compact with.'),
+    ] = None,
     output_format: Annotated[
         OutputFormat,
         Option(help='Format to output the data at.'),
@@ -212,7 +212,7 @@ def compact(   # noqa: WPS211
     """Compact a ⋆-LD document."""
     response = yaml_ld.compact(
         document=decode_input(input_),
-        ctx=decode_input(ctx),
+        ctx=ctx or {},
         options=CompactOptions(
             base=base,
             extract_all_scripts=extract_all_scripts,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: yaml_ld.document_loaders.default.DEFAULT_DOCUMENT_LOADER