Generate & host API docs #138

New Issue

Jef Roosens · 2022-04-29T10:18:24+02:00

Jef Roosens commented

2022-04-29 10:18:24 +02:00

Using vdoc, we could generate documentation for the entire codebase, including private functions. This could be useful for others users who which to use the codebase, or contribute to the project. I would also just use it myself.

Using my site backend, we could deploy this documentation to my website on every push to dev.

Besides this, I'd also like to use vlib/tools/missdoc.v to enforce comment strings on every function, not just public ones. Preferably I'd also like to add a README to all major components of the codebase.

Using vdoc, we could generate documentation for the entire codebase, including private functions. This could be useful for others users who which to use the codebase, or contribute to the project. I would also just use it myself. Using my site backend, we could deploy this documentation to my website on every push to dev. Besides this, I'd also like to use `vlib/tools/missdoc.v` to enforce comment strings on *every* function, not just public ones. Preferably I'd also like to add a README to all major components of the codebase.

Jef Roosens added this to the 0.3.0 milestone 2022-04-29 10:18:24 +02:00

Jef Roosens added the

enhancement

label 2022-04-29 10:18:24 +02:00

Jef Roosens added the

docs

label 2022-04-29 10:46:26 +02:00

Jef Roosens referenced a pull request that will close this issue

2022-04-30 23:39:35 +02:00

Move over documentation #143

Jef Roosens closed this issue

2022-05-01 12:17:39 +02:00