cognitedata / cognitedata/cognite-sdk-python
Find a way of including type aliases in the docs
Open
Nobody has claimed this yet.
docs
enhancement
- Dominant language
- Python
- Stars
- 92
- Forks
- 38
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 42
Description
Type aliases like e.g. https://github.com/cognitedata/cognite-sdk-python/blob/master/cognite/client/data_classes/datapoints.py#L358 don't show up in the docs. I believe sphinx has some functionality for this.
Contributor guide
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
Start with the type alias example in cognite/client/data_classes/datapoints.py around line 358, then inspect the Sphinx documentation configuration and autodoc behavior. Determine how the alias can appear in the generated docs and verify the result with the documentation build; done means type aliases are included and rendered correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100