Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

Host java- and scaladoc on Github Pages #92

Closed
@J0B10

Description

@J0B10

Description

I'dd like to suggest that we host the scaladoc for the framework and the javadoc of the api on github pages and keep it up to date with the master branch, so that plugin developers can easily use it and we can reference it on github pages.

Github Pages has the advantage over hosting on a private webserver that every contributor with push acces to the repo can update the documentation by pushing to the gh-pages branch.

It also allows everybody to create a local copy by just cloning the branch.

I'dd do the following things:

  • Deploy the docs to github pages.
  • (Optional) Setup travis to auto generate the docs and push them

@sebinside could do:

References

https://pages.github.com/
https://help.github.com/en/articles/using-a-custom-domain-with-github-pages

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestminorQuick to implement

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions