Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Jul 17, 2024

Conversation

MoltonMontro
Copy link
Member

@MoltonMontro MoltonMontro commented Jul 16, 2024

Not affected by this deprecation, but it will be required in the future.

Also:
- Removed release/version numbers; they weren't relevant.
- Created a new requirements.txt with pip-compile
I'm silly - although Jinja2 was installed by default, I don't believe it's used by default (& we weren't using any jinja templates AFAIK)
@MoltonMontro
Copy link
Member Author

MoltonMontro commented Jul 17, 2024

@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
Copy link

humitos commented Jul 17, 2024

@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
Copy link
Member

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
Copy link
Member Author

@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
Copy link

humitos commented Jul 17, 2024

@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 👍🏼

@SDGNelson SDGNelson merged commit a3c6120 into SmartlyDressedGames:latest Jul 17, 2024
2 checks passed
@MoltonMontro MoltonMontro deleted the rtd-addons branch July 18, 2024 01:54
@MoltonMontro MoltonMontro changed the title Update conf.py due to deprecation of Sphinx context injection at build time Update conf.py due to deprecation of Sphinx context injection at build time (October 7th) Oct 2, 2024
@MoltonMontro MoltonMontro changed the title Update conf.py due to deprecation of Sphinx context injection at build time (October 7th) Update conf.py due to deprecation of Sphinx context injection at build time Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants