SmartlyDressedGames / Unturned-Docs

Documentation for Unturned's modding features.
134 stars 49 forks source link

Update conf.py due to deprecation of Sphinx context injection at build time #351

Closed MoltonMontro closed 1 month ago

MoltonMontro commented 1 month ago

Tentative fix per https://about.readthedocs.com/blog/2024/07/addons-by-default/.

We probably won't need to do anything else as part of the migration to RTD Addons.

These GH issues are both somewhat relevant:

MoltonMontro commented 1 month ago

@SDGNelson RTD Addons will eventually be enabled for all projects by default on October 7th. We can enable addons now though, and make sure everything is working. https://docs.readthedocs.io/en/stable/addons.html#enabling-read-the-docs-addons

humitos commented 1 month ago

@MoltonMontro I can enable the DISABLE_SPHINX_MANIPUALTION feature flag in your project if you want to perform the tests. That flag, together with enabling Read the Docs Addons manually emulates the default future behavior. Let me know.

SDGNelson commented 1 month ago

I've now enabled addons for the Unturned project. 👍

We're big fans of RTD, thanks for reaching out @humitos! Sure, I think we'd be up to test with Sphinx manipulation disabled. What do you think Molt?

MoltonMontro commented 1 month ago

@MoltonMontro I can enable the DISABLE_SPHINX_MANIPUALTION feature flag in your project if you want to perform the tests. That flag, together with enabling Read the Docs Addons manually emulates the default future behavior. Let me know.

@humitos Sure! If you could enable that flag, we'd appreciate it. :)

humitos commented 1 month ago

@humitos Sure! If you could enable that flag, we'd appreciate it. :)

Cool! I enabled the flag in the unturned project. Let me know if everything works as expected. I'd really appreciate any feedback you may have 👍🏼