incf-nidash / PyNIDM

Other
21 stars 31 forks source link

README and `docs/source/index.rst` do not agree on REST API #358

Open jwodder opened 1 year ago

jwodder commented 1 year ago

Currently (as of commit 9351c88), the descriptions in the REST API in README.rst and docs/source/index.rst do not completely agree. In particular:

yarikoptic commented 1 year ago

after the difference figured out and fixed -- we should "deprecate" README.md as a copy of docs/source/index.rst and keep detailed info within docs (and probably post rendered version on RTD). Ref: https://github.com/incf-nidash/PyNIDM/pull/357#discussion_r1185210317

yarikoptic commented 1 year ago

apparently there is an RTD project already setup and there is https://pynidm.readthedocs.io

jwodder commented 1 year ago

@yarikoptic The docs build is failing, though, so the updates in #357 aren't taking effect. I would need access to the project on Read the Docs in order to figure out what's going on.

jwodder commented 1 year ago

The docs are building again now.