conan-io / conan-io/docs

Autogenerate Code Documentation

Open
#696 3 comments 0 reactions 0 assignees View on GitHub
complex: huge priority: low stage: queue type: look into
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

Maintaining documentation is always a chore, but nothing is more frustrating when the documentation itself is not up to date. I would be willing to work with Conan dev's to implement a system to automatically generate the documentation from the code. There are a number of standards and tools available to help facilitate this.

With sufficiently formatted docstrings and a consistent standard enforced during development, issues like the one I just wrote up, #695 , could be mitigated with little to no actual work.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.