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

Auto-generate docs on build #8

Closed
rmil opened this issue Oct 15, 2020 · 4 comments
Closed

Auto-generate docs on build #8

rmil opened this issue Oct 15, 2020 · 4 comments
Labels
enhancement New feature or request

Comments

@rmil
Copy link
Member

rmil commented Oct 15, 2020

We can then ensure we are always on the latest version of the docs. Also, we can then provide feedback if it's a successful doc compile for each commit.

Need to run swag init -g routes/router.go and the docs will generate. This does require swag as a dependency however.

@rmil rmil added the enhancement New feature or request label Oct 15, 2020
@rmil
Copy link
Member Author

rmil commented Oct 18, 2020

Did a little nosey into this, you'll need to update the Dockerfile to just include the go get of the binary and just execute that command. The issue is that it's having issues generating docs when the model features an external model inside of itself (a lot of models benefit from the null package, so this makes it difficult to implement).

@rmil
Copy link
Member Author

rmil commented Oct 18, 2020

Only seem to be having issues when I'm not generating in my normal dev environment, so in docker it has issues whilst outside it doesn't

@cs-endo
Copy link
Contributor

cs-endo commented Dec 13, 2021

It's not strictly been coded to auto generate these but a working process of generating docs is in the install procedure

@rmil
Copy link
Member Author

rmil commented Jan 2, 2022

Fixed in #15

@rmil rmil closed this as completed Jan 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants