Giters

weso / shex-s

Scala implementation of ShEx

Home Page:http://www.weso.es/shex-s/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs automation

labra opened this issue · comments

commented

The documentation of the project will be available at: https://www.weso.es/shex-s/

We want to have the following features:

  • Automatic generation of ScalaDoc. Currently available at API Docs
  • Examples about how to invoke the library in Scala that are automatically compiled and checked that they run
  • Some description of the architecture in markdown
  • Automatic generation of the documentation. Currently with sbt docs/mdoc
  • Automatic creation of website. It should be done with sbt docusaurusCreateSite
  • Automatic publication of the documentation. It should be done with sbt docusaurusPublishSite. It is failing, there seems to be an error in ssh deploy_key.