Closed ni-jfitzger closed 1 year ago
I have decided to revert changes related to independent versioning and restrict this to changes needed for the doc split.
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!
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
, theypip install nidmm
(or some other module) and would expect to find the documentation fornidmm
notnimi-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:
docs/<module>.rst
into module-specific folders, and began generating them from driver.rst.mako (becausetox -e clean
deletes that folderdocs/index.rst
intodocs/<module>/index.rst
files generated from a template.src/<module>/
List issues fixed by this Pull Request below, if any.
What testing has been done?
See the links to the built documentation.
TODOs