Set autoapi_own_page_level for certain classes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Tech Debt
FYI: it would be nice to have autoapi_own_page_level = "class" for bintime/waveform and autoapi_own_page_level = "module" for scalar/vector. Making this happen would probably require disabling the auto-generated toctree and writing stub doc files that use the autodoc-style .. autoapimodule:: and .. autoapiclass:: directives.
Context: https://github.com/ni/nitypes-python/pull/161#discussion_r2243342761
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 by inspecting the current AutoAPI-generated toctree and documentation setup for bintime/waveform and scalar/vector. Determine whether stub files using the autodoc-style .. autoapimodule:: and .. autoapiclass:: directives are needed. Done means bintime and waveform have class-level pages, while scalar and vector have module-level pages, with the generated navigation still working.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100