Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs refactor #33

Merged
merged 5 commits into from
Jul 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
*.old
.coverage
coverage.xml
.idea
project/
docs/
tmp/
site/
__pycache__
10 changes: 7 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

19 changes: 19 additions & 0 deletions docs/api/compiler.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/api/functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Functions Package

## Unit Conversion

::: linkml_map.functions.unit_conversion
13 changes: 13 additions & 0 deletions docs/api/inference.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions docs/api/session.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Session

::: linkml_map.session.Session

10 changes: 10 additions & 0 deletions docs/api/transformer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Transformer Package

## Transformer (Base Class)

::: linkml_map.transformer.transformer.Transformer

## ObjectTransformer

::: linkml_map.transformer.object_transformer.ObjectTransformer

Loading
Loading