Skip to content

Generate documentation and host it with Pages. #32

Open
@agarcialeon

Description

@agarcialeon

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.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions