search

openworm / openworm_docs

Documentation for OpenWorm, i.e. docs.openworm.org
http://docs.openworm.org
43 stars 28 forks source link

Add .openworm.yml metadata to geppetto repositories #69

Open mwatts15 opened 4 years ago

mwatts15 commented 4 years ago

Automated repository crawler for the documentation would be lacking several geppetto libraries. This issue is to add a basic .openworm.yml to libraries in the geppetto project that indicates the relationships between them.

pgleeson commented 4 years ago

@mwatts15 Is there a doc/file somewhere outlining all the mandatory/optional fields in the .openworm.yml?

casperdcl commented 4 years ago

@pgleeson I talked with @cheelee and understand there isn't (atm). But I've looked through all the files and found these keys so far: https://github.com/openworm/openworm_docs/blob/4022f3cd0b0cd36def49723ad265eb3a6585afe6/build.py#L190-L208

casperdcl commented 4 years ago

See https://github.com/openworm/org.geppetto/blob/master/.openworm.yml and https://github.com/openworm/openworm_docs/blob/master/.openworm.yml for ideas...

pgleeson commented 4 years ago

Thanks @casperdcl. FYI I've added/updated yml files here:

https://github.com/openworm/c302/blob/master/.openworm.yml https://github.com/openworm/CElegansNeuroML/blob/master/.openworm.yml https://github.com/openworm/JohnsonMailler_MuscleModel/blob/master/.openworm.yml https://github.com/openworm/muscle_model/blob/master/.openworm.yml https://github.com/openworm/hodgkin_huxley_tutorial/blob/master/.openworm.yml

pgleeson commented 4 years ago

Some suggestions for harmonising the yml files here: https://github.com/openworm/openworm_docs/issues/70

casperdcl commented 4 years ago

OK latest version https://818-12814245-gh.circle-artifacts.com/0/home/circleci/repo/site/gsod19/repos/index.html