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

Fix mkdocs & rtfd build #564

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

janbrasna
Copy link
Contributor

@janbrasna janbrasna commented Jun 12, 2024

The docs are actually not even building for almost a year now:

Screenshot 2024-06-12 at 23 31 51

It stopped without any apparent reason, so probably just adding the yaml config should fix the builds.

This PR also updates the mkdocs version to help with some dependency woes et al. to be super-uptodate to avoid any surprises. (Also to close #548 too.)

The [email protected] + [email protected] log can be verified here for 1847787

The [email protected] log is here for 0ea4e2b

Building RTD previews for PRs would need to be enabled in its settings first (not sure if that wouldn't first expect working config anyhoo), but since this can't really break more it shouldn't be necessary.

@janbrasna
Copy link
Contributor Author

janbrasna commented Jun 29, 2024

FYI mkdocs now supports dark theme starting from 1.6.0/b5, so I flipped the switches to auto/system +picker — [DEMO]

requirements.txt Outdated Show resolved Hide resolved
* Add auto mkdocs darkmode
* Update mkdocs to v1.6.1
@robhudson
Copy link
Contributor

robhudson commented Sep 19, 2024

Just FYI: We're going to sunset this repo shortly once some work with migrating to django-waffle is completed, so I wouldn't spend a lot of time on improvements here.

More info: The static configs and funnelcakes are no longer used. The only thing used currently is waffle switches which will be replaced with database-based switches with django-waffle. Then this repo will be archived and no longer used.

@janbrasna
Copy link
Contributor Author

@robhudson Yep, I'm aware, worry not — I'm basically trying (along with the sibling PR for gh-pages) to fix the publishing workflow to perhaps allow publishing the actual deprecation info to the docs sites too, if/when needed — not leaving behind two outdated docs deployments for an archived repo dangling around;)

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.

2 participants