gene-weaver / docs-lm2 Goto Github PK

Pydata allows for the addition of a version switcher through a json configuration to allow for the documentation to be specific to a tag in the main program. The documentation for how to implement this can be found at https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html

Currently leafmachine2 is at version 2.1, and so this is where we should begin. When new tagged releases of leafmachine2 are made, the documentation should switch to resemble that version. This enables researchers to refer to the documentation for the version they are running if they are unable to upgrade (because of limitations on which version of a dependency they are able to install etc).