Support math equations in documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
nirfsg has some attributes and functions which refer to math equations (which were probably lost in the process of creating the Python help from C Help).
Here's an example documentation page for the C API: https://www.ni.com/docs/en-US/bundle/ni-rfsg-c-api-ref/page/cvirfsg/nirfsg_attr_offset_units.html
We don't have any existing documentation with equations, that I'm aware of, so we'll most likely need to add support.
Sphinx has multiple extensions for math.
Apparently LaTeX is "the de-facto standard for plain-text math notation", but I'm not at all familiar with it.
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 reviewing how the Python help documentation is generated and compare the Sphinx math extensions linked in the issue. Use the linked C API page as a reference for the missing equations. Done means equations referenced by nirfsg attributes and functions render correctly in the generated Python documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100