Merge pull request #33 from linkml/docs-refactor

linkml · Jul 4, 2024 · a5554d2 · a5554d2
2 parents 2fe7d8e + 5a87624
commit a5554d2
Show file tree

Hide file tree

Showing 129 changed files with 12,616 additions and 758 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
+*.old
+.coverage
+coverage.xml
 .idea
 project/
-docs/
 tmp/
 site/
 __pycache__

diff --git a/Makefile b/Makefile
@@ -81,7 +81,9 @@ serve: mkd-serve
 deploy: mkd-deploy
 
 # Deploy gh docs
-deploy-gh-doc: gendoc
+# https://github.com/linkml/linkml/issues/2193
+#deploy-gh-doc: gendoc
+deploy-gh-doc:
 	$(RUN) mkdocs gh-deploy
 
 
@@ -94,9 +96,11 @@ $(PYMODEL):
 $(DOCDIR):
 	mkdir -p $@
 
+#docsync:
+#	cp -pr $(SRC)/docs/* $(DOCDIR)
+
 gendoc: $(DOCDIR)
-	cp -pr $(SRC)/docs/* $(DOCDIR) ; \
-	$(RUN) gen-doc -d $(DOCDIR) $(SOURCE_SCHEMA_PATH) --index-name datamodel
+	$(RUN) gen-doc -d $(DOCDIR)/schema $(SOURCE_SCHEMA_PATH) --index-name datamodel
 
 testdoc: gendoc serve
 

diff --git a/README.md b/README.md
@@ -33,4 +33,5 @@ Not all parts of the model are implemented in the reference Python framework.
 * [Tutorial Notebook](src/docs/examples/Tutorial.ipynb)
 * [Generated Docs](https://linkml.github.io/linkml-map/)
 * [Compliance Suite](https://linkml.github.io/linkml-map/specification/compliance)
+* [API Docs](https://linkml.github.io/linkml-map/api)
 
diff --git a/docs/api/compiler.md b/docs/api/compiler.md
@@ -0,0 +1,19 @@
+# Compiler Package
+
+A compiler will compile a Map specification into an alternative representation
+
+## Compiler (Base Class)
+
+::: linkml_map.compiler.compiler.Compiler
+
+## Python Compiler
+
+::: linkml_map.compiler.python_compiler.PythonCompiler
+
+## Markdown Compiler
+
+::: linkml_map.compiler.markdown_compiler.MarkdownCompiler
+
+### Graphviz Compiler
+
+::: linkml_map.compiler.graphviz_compiler.GraphvizCompiler
diff --git a/docs/api/functions.md b/docs/api/functions.md
@@ -0,0 +1,5 @@
+# Functions Package
+
+## Unit Conversion
+
+::: linkml_map.functions.unit_conversion
diff --git a/docs/api/inference.md b/docs/api/inference.md
@@ -0,0 +1,13 @@
+# Inference Package
+
+## Inference Utils
+
+::: linkml_map.inference.inference
+
+## Inverter
+
+::: linkml_map.inference.inverter
+
+## Schema Mapper
+
+::: linkml_map.inference.schema_mapper.SchemaMapper
diff --git a/docs/api/session.md b/docs/api/session.md
@@ -0,0 +1,4 @@
+# Session
+
+::: linkml_map.session.Session
+
diff --git a/docs/api/transformer.md b/docs/api/transformer.md
@@ -0,0 +1,10 @@
+# Transformer Package
+
+## Transformer (Base Class)
+
+::: linkml_map.transformer.transformer.Transformer
+
+## ObjectTransformer
+
+::: linkml_map.transformer.object_transformer.ObjectTransformer
+