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

Generate documentation and host it with Github Pages. #32

Open
agarcialeon opened this issue May 7, 2019 · 0 comments
Open

Generate documentation and host it with Github Pages. #32

agarcialeon opened this issue May 7, 2019 · 0 comments

Comments

@agarcialeon
Copy link
Contributor

Althougt code can be commented in the scripts, could be great to generate automatic documentation for the scripts and host it in the gh-pages branch of this repository.

In this way we can have a presentation web for the library and also the related documentation on how the API works.

I have checked DocFX and it seems it's possible to implement the pipeline for hosting the documentation as stated. See it here.

DocFX is just an example, but if you find another better solution we could use it too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Roadmap
To be considered
Development

No branches or pull requests

1 participant