Added documentation (#8)

* Updated docs command * Updated styling * Added structure * Improved docs * Fixed mkdocs config * Added docstrings to plugins * Finished package/resource mappers docs * Finished plugins docs * Added package example * Added actions docs * Updated docs structure * Added main narrative docs * Added extending models * Added frictionless-py note * Added resource docs * Added dialect docs * Minor fixes * Added schema docs
frictionlessdata · Dec 17, 2023 · 102f018 · 102f018
1 parent dc446a2
commit 102f018
Show file tree

Hide file tree

Showing 60 changed files with 1,968 additions and 46 deletions.
diff --git a/docs/actions/dialect.md b/docs/actions/dialect.md
@@ -0,0 +1,9 @@
+# Dialect
+
+Here is a list of available actions for Table Dialect:
+
+- `check_dialect` -- check the descriptor against JSON Schema(s)
+
+## Reference
+
+::: dplib.actions.dialect.check.check_dialect
diff --git a/docs/actions/package.md b/docs/actions/package.md
@@ -0,0 +1,11 @@
+# Package
+
+Here is a list of available actions for Data Package
+
+- `check_package` -- check the descriptor against JSON Schema(s)
+- `convert_package` -- convert the descriptor from one notation to another
+
+## Reference
+
+::: dplib.actions.package.check.check_package
+::: dplib.actions.package.convert.convert_package
diff --git a/docs/actions/resource.md b/docs/actions/resource.md
@@ -0,0 +1,11 @@
+# Resource
+
+Here is a list of available actions for Data Resource
+
+- `check_package` -- check the descriptor against JSON Schema(s)
+- `convert_package` -- convert the descriptor from one notation to another
+
+## Reference
+
+::: dplib.actions.resource.check.check_resource
+::: dplib.actions.resource.convert.convert_resource
diff --git a/docs/actions/schema.md b/docs/actions/schema.md
@@ -0,0 +1,9 @@
+# Schema
+
+Here is a list of available actions for Table Schema:
+
+- `check_schema` -- check the descriptor against JSON Schema(s)
+
+## Reference
+
+::: dplib.actions.schema.check.check_schema
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/logo-dark.svg b/docs/assets/logo-dark.svg
diff --git a/docs/assets/logo-light.svg b/docs/assets/logo-light.svg
diff --git a/docs/contributing/development.md → docs/contributing.md b/docs/contributing/development.md → docs/contributing.md
@@ -44,7 +44,7 @@ hatch run serve
 Building the docs:
 
 ```bash
-hatch run docs
+hatch run build
 ```
 
 ## Testing