Skip to content

WIP DO NOT MERGE: experiment in adding LinkML derived markdown docs #57

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
92 changes: 92 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
SRC_DIR = src
SCHEMA_DIR = $(SRC_DIR)/schema
SOURCE_FILES := $(shell find $(SCHEMA_DIR) -name '*.yaml')
SCHEMA_NAMES = $(patsubst $(SCHEMA_DIR)/%.yaml, %, $(SOURCE_FILES))

TARGETDIR = .

SCHEMA_NAME = mixs
SCHEMA_SRC = $(SCHEMA_DIR)/$(SCHEMA_NAME).yaml
TGTS = graphql jsonschema docs shex owl csv graphql python

#GEN_OPTS = --no-mergeimports
GEN_OPTS =

all: gen-all
gen: $(patsubst %,gen-%,$(TGTS))

t:
echo $(SCHEMA_NAMES)

echo:
echo $(patsubst %,gen-%,$(TGTS))

test: all

install:
. environment.sh
pip install -r requirements.txt

tdir-%:
mkdir -p $(TARGETDIR)/$*
docs:
mkdir $@

stage: $(patsubst %,stage-%,$(TGTS))
stage-%: gen-%
cp -pr $(TARGETDIR)/$* .


### -- MARKDOWN DOCS --
# Generate documentation ready for mkdocs
# TODO: modularize imports
gen-docs: $(TARGETDIR)/mixs6/index.md
.PHONY: gen-docs
$(TARGETDIR)/mixs6/%.md: $(SCHEMA_SRC)
gen-markdown $(GEN_OPTS) --dir $(TARGETDIR)/mixs6 $<

### -- MARKDOWN DOCS --
# TODO: modularize imports. For now imports are merged.
gen-graphql:$(TARGETDIR)/graphql/$(SCHEMA_NAME).graphql
$(TARGETDIR)/graphql/%.graphql: $(SCHEMA_DIR)/%.yaml tdir-graphql
gen-graphql $(GEN_OPTS) $< > $@

### -- JSON schema --
# TODO: modularize imports. For now imports are merged.
gen-jsonschema: $(TARGETDIR)/jsonschema/$(SCHEMA_NAME).schema.json
$(TARGETDIR)/jsonschema/%.schema.json: $(SCHEMA_DIR)/%.yaml tdir-jsonschema
gen-json-schema $(GEN_OPTS) -t transaction $< > $@

### -- Shex --
# one file per module
gen-shex: $(patsubst %, $(TARGETDIR)/shex/%.shex, $(SCHEMA_NAMES))
$(TARGETDIR)/shex/%.shex: $(SCHEMA_DIR)/%.yaml tdir-shex
gen-shex --no-mergeimports $(GEN_OPTS) $< > $@

### -- CSV --
# one file per module
gen-csv: $(patsubst %, $(TARGETDIR)/csv/%.csv, $(SCHEMA_NAMES))
$(TARGETDIR)/csv/%.csv: $(SCHEMA_DIR)/%.yaml tdir-csv
gen-csv $(GEN_OPTS) $< > $@

### -- OWL --
# TODO: modularize imports. For now imports are merged.
gen-owl: $(TARGETDIR)/owl/$(SCHEMA_NAME).owl.ttl
.PHONY: gen-owl
$(TARGETDIR)/owl/%.owl.ttl: $(SCHEMA_DIR)/%.yaml tdir-owl
gen-owl $(GEN_OPTS) $< > $@

### -- RDF (direct mapping) --
# TODO: modularize imports. For now imports are merged.
gen-rdf: $(TARGETDIR)/rdf/$(SCHEMA_NAME).ttl
$(TARGETDIR)/rdf/%.ttl: $(SCHEMA_DIR)/%.yaml tdir-rdf
gen-rdf $(GEN_OPTS) $< > $@

### -- LinkML --
# linkml (copy)
# one file per module
gen-linkml: $(TARGETDIR)/linkml/$(SCHEMA_NAME).yaml
$(TARGETDIR)/linkml/%.yaml: $(SCHEMA_DIR)/%.yaml tdir-limkml
cp $< > $@


2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% include header.html %}

<br>
<p style="font-size:30px; color:red" >THIS IS A DEVELOPMENT VERSION OF THE GSC Website<br><br>
<p style="font-size:30px; color:red" >THIS IS A DEVELOPMENT VERSION OF THE GSC Website (cjm version)<br><br>
For the live website, please visit <a href="https://gensc.org/">https://gensc.org/</a>.</p>
<br>

Expand Down
19 changes: 19 additions & 0 deletions mixs6/AddRecovMethodEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: add_recov_method_enum




URI: [mixs.vocab:add_recov_method_enum](https://w3id.org/mixs/vocab/add_recov_method_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

169 changes: 169 additions & 0 deletions mixs6/Air.md

Large diffs are not rendered by default.

400 changes: 400 additions & 0 deletions mixs6/AirMIGSBacteria.md

Large diffs are not rendered by default.

400 changes: 400 additions & 0 deletions mixs6/AirMIGSEukaryote.md

Large diffs are not rendered by default.

370 changes: 370 additions & 0 deletions mixs6/AirMIGSPlant.md

Large diffs are not rendered by default.

395 changes: 395 additions & 0 deletions mixs6/AirMIGSVirus.md

Large diffs are not rendered by default.

320 changes: 320 additions & 0 deletions mixs6/AirMIMARKSSpecimen.md

Large diffs are not rendered by default.

300 changes: 300 additions & 0 deletions mixs6/AirMIMARKSSurvey.md

Large diffs are not rendered by default.

335 changes: 335 additions & 0 deletions mixs6/AirMe.md

Large diffs are not rendered by default.

355 changes: 355 additions & 0 deletions mixs6/AirMigsOrg.md

Large diffs are not rendered by default.

410 changes: 410 additions & 0 deletions mixs6/AirMimag.md

Large diffs are not rendered by default.

415 changes: 415 additions & 0 deletions mixs6/AirMisag.md

Large diffs are not rendered by default.

485 changes: 485 additions & 0 deletions mixs6/AirMiuvig.md

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions mixs6/ArchStrucEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: arch_struc_enum




URI: [mixs.vocab:arch_struc_enum](https://w3id.org/mixs/vocab/arch_struc_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/AssemblyQualEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: assembly_qual_enum




URI: [mixs.vocab:assembly_qual_enum](https://w3id.org/mixs/vocab/assembly_qual_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BinParamEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: bin_param_enum




URI: [mixs.vocab:bin_param_enum](https://w3id.org/mixs/vocab/bin_param_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BinSoftwareEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: bin_software_enum




URI: [mixs.vocab:bin_software_enum](https://w3id.org/mixs/vocab/bin_software_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BiolStatEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: biol_stat_enum




URI: [mixs.vocab:biol_stat_enum](https://w3id.org/mixs/vocab/biol_stat_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BioticRelationshipEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: biotic_relationship_enum




URI: [mixs.vocab:biotic_relationship_enum](https://w3id.org/mixs/vocab/biotic_relationship_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BuildDocsEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: build_docs_enum




URI: [mixs.vocab:build_docs_enum](https://w3id.org/mixs/vocab/build_docs_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BuildOccupTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: build_occup_type_enum




URI: [mixs.vocab:build_occup_type_enum](https://w3id.org/mixs/vocab/build_occup_type_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

19 changes: 19 additions & 0 deletions mixs6/BuildingSettingEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

# Enum: building_setting_enum




URI: [mixs.vocab:building_setting_enum](https://w3id.org/mixs/vocab/building_setting_enum)


## Other properties

| | | |
| --- | --- | --- |

## Permissible Values

| Text | Meaning |
| :--- | --------: |

Loading