crossbario / txaio

Utilities to support code that runs unmodified on Twisted and asyncio
MIT License
58 stars 30 forks source link

readthedocs broken #183

Open adamchainz opened 2 years ago

adamchainz commented 2 years ago

The latest release rendered on RtD is 20.1.1: https://txaio.readthedocs.io/en/latest/releases.html

This misses >2 years of releases: https://github.com/crossbario/txaio/blob/master/docs/releases.rst

You may need to reconfigure something on RtD. These days you can set up RtD to build on PR's, which I'd recommend. 😇

oberstet commented 2 years ago

yeah, it actually seems like we triggered the RTD build manually in the past .. IOW, we're missing a config like

https://github.com/crossbario/autobahn-python/blob/master/readthedocs.yml

in https://readthedocs.org/projects/txaio/.

fwiw, I've manually triggered it one more time now so the RTD docs provide the current docs

https://txaio.readthedocs.io/en/latest/

adamchainz commented 2 years ago

Yeah setting up a file is a good idea, it allows you to enable PR builds as well to check no change breaks the docs.

Here's an example from one of my projects: https://github.com/adamchainz/django-mysql/blob/main/.readthedocs.yaml . Note the . prefix to the name is preferred from v2 onwards, as per RtD's own docs: https://docs.readthedocs.io/en/stable/config-file/v2.html .

oberstet commented 1 year ago

Hello,
--
The Read the Docs build system will start requiring a configuration file v2 (.readthedocs.yaml) starting on September 25, 2023. We are sending weekly notifications about this issue to all impacted users, as well as temporary build failures (brownouts) as the date approaches for those who haven't migrated their projects.  The timeline for this deprecation is as follows:       Monday, July 24, 2023: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon)     Monday, August 14, 2023: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight)     Monday, September 4, 2023: Do a third and final  brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST  to September 5, 2023 23:59 PST (midnight)     Monday, September 25, 2023: Fully remove support for building documentation without configuration file v2.   We have identified that the following projects which you maintain are impacted by this deprecation:        txaio     Please add a configuration file to your projects to ensure that they  continue building successfully and to stop receiving these  notifications.  For more information on how to create a required configuration file, read our blog post  Get in touch with us via our support and let us know if you are unable to use a configuration file for any reason.
Keep documenting,                       Read the Docs

Hello,
The Read the Docs build system will start requiring a configuration file v2 (.readthedocs.yaml) starting on September 25, 2023. We are sending weekly notifications about this issue to all impacted users, as well as temporary build failures (brownouts) as the date approaches for those who haven't migrated their projects. The timeline for this deprecation is as follows:

    Monday, July 24, 2023: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon)
    Monday, August 14, 2023: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight)
    Monday, September 4, 2023: Do a third and final brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST to September 5, 2023 23:59 PST (midnight)
    Monday, September 25, 2023: Fully remove support for building documentation without configuration file v2.

We have identified that the following projects which you maintain are impacted by this deprecation:

    [txaio](https://readthedocs.org/projects/txaio/)

Please add a configuration file to your projects to ensure that they continue building successfully and to stop receiving these notifications. For more information on how to create a required configuration file, [read our blog post](https://blog.readthedocs.com/migrate-configuration-v2/) Get in touch with us [via our support](https://readthedocs.org/support/) and let us know if you are unable to use a configuration file for any reason.
Keep documenting,
Read the Docs