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 automation #205

Open
2 of 6 tasks
labra opened this issue Apr 25, 2021 · 0 comments
Open
2 of 6 tasks

Docs automation #205

labra opened this issue Apr 25, 2021 · 0 comments

Comments

@labra
Copy link
Member

labra commented Apr 25, 2021

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant