Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Introduce API-Docu, build automatically #441

Closed
5 tasks done
aeimer opened this issue Dec 14, 2017 · 1 comment · Fixed by #519
Closed
5 tasks done

Introduce API-Docu, build automatically #441

aeimer opened this issue Dec 14, 2017 · 1 comment · Fixed by #519
Assignees
Labels
api All Backend related Issues enhancement This issue improves geli infrastructure This is not code related, docker, batches etc.

Comments

@aeimer
Copy link
Collaborator

aeimer commented Dec 14, 2017

User Story

As a:

Developer

I want:

to have an API-Documentation

so that:

I can see all URL-Paths and their functions.

Acceptance criteria:

  • All API-Functions are commented
  • Build the Documentation on build time
  • The documentation should be generated only on tagged builds
  • Publish the build (as GH Pages)
  • The version of the docu should be switched

Additional info:

https://pages.github.com/


Please tag this issue if you are sure to which tag(s) it belongs.

@aeimer aeimer added api All Backend related Issues enhancement This issue improves geli infrastructure This is not code related, docker, batches etc. labels Dec 14, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api All Backend related Issues enhancement This issue improves geli infrastructure This is not code related, docker, batches etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants