Stop publishing documentation to old nimi-python readthedocs project.

ni / nimi-python

Python bindings for NI Modular Instrument drivers.

Other

111 stars 84 forks source link

Stop publishing documentation to old nimi-python readthedocs project. #1978

Closed ni-jfitzger closed 1 year ago

ni-jfitzger commented 1 year ago

Description of issue

We have new, individual Read the Docs projects and the index for latest of the old one has links to them. We don't need to continue building the old project. We should update that project to not build new versions and delete the configuration files, .rsts specific to it.

ni-jfitzger commented 1 year ago

Perhaps we should also remove the webhook integration for the project, so that it doesn't even attempt to build the project anymore. That's just a waste of computing resources.

ni-jfitzger commented 1 year ago

I deleted the webhook in this GitHub project that matched the integration for the nimi-python Read the Docs project. I also deleted the integration from the Read the Docs project.

ni-jfitzger commented 1 year ago

Created a new webhook after noticing the following issues:

index.rst for the old project links to latest versions of documentation, not stable. stable is preferred as the default version. Latest may have documentation which reflects unreleased changes.
users could find links to hidden html pages in the old project's 1.4.5 documentation through banner links in previous versions.
- For the latest documentation in that project, we only want users to see the index.rst. Anything else and it may not be clear that the documentation has moved.

ni-jfitzger commented 1 year ago

After fixing the previously mentioned issues by temporarily pointing 1.4.5 at the post-release changes commit, I have deleted the webhook, again.