ni / nimi-python

Python bindings for NI Modular Instrument drivers.
Other
112 stars 84 forks source link

Split the docs #1963

Closed ni-jfitzger closed 1 year ago

ni-jfitzger commented 1 year ago

What does this Pull Request accomplish?

To have different readthedocs pages for each of the driver modules in nimi-python. Clients don't care about nimi-python, they pip install nidmm (or some other module) and would expect to find the documentation for nidmm not nimi-python.

This change also paves the road toward individual nimi-python packages to maintain independent versions, following semver guidance, and release independently. This will allow patch-fix releases to be made more easily.

Major Changes:

What testing has been done?

See the links to the built documentation.

TODOs

ni-jfitzger commented 1 year ago

I have decided to revert changes related to independent versioning and restrict this to changes needed for the doc split.

marcoskirsch commented 1 year ago

Very little feedback on my part, I think it will be more efficient to push this in and then we can do a pass on how things look and what outdated stuff remains or what needs to be reworded.

This is great!