Find a way to document freetype and windows-specific code
Open
Nobody has claimed this yet.
help wanted
priority: medium
- Dominant language
- C++
- Stars
- 107
- Forks
- 45
- Avg merge
- 13h 41m
- Merged PRs (30d)
- 7
Description
Certain parts of aggdraw are only available if running/built on Windows or if aggdraw was built with freetype support. Right now I'm making aggdraw docs on readthedocs which is not as easy to accomplish this stuff with. I see two options:
- Generate documentation on travis/appveyor (that would mean building on Windows with freetype).
- Manually copy/document those pieces of the package in the
.rstfiles.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing Read the Docs setup and the package's .rst files, then compare the two proposed approaches: generating documentation through Travis/AppVeyor or documenting the conditional Windows and FreeType-supported pieces manually. Done means the platform- and build-dependent API is represented consistently in the published documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system, documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100