Support math equations in documentation

Open
#2,112 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

docs enhancement nirfsg

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.

Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ni/nimi-python

All issues in ni/nimi-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.