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

Cannot apply sphinx-book-theme upgrade to cookiecutters (logo_only) #359

Open
1 task
timmc-edx opened this issue Jun 21, 2023 · 0 comments
Open
1 task

Comments

@timmc-edx
Copy link
Contributor

timmc-edx commented Jun 21, 2023

Acceptance criteria:

  • Ensure that cookiecutters docs config matches our official guide for docs (one way or another)

In #355 we discovered that the "logo_only": True present in the python-template's docs/conf.py was causing doc builds to fail. Specifically, using cookiecutter-python-library and then running make docs in the output results in the following error:

Warning, treated as error:
unsupported theme option 'logo_only' given

This is contrary to https://docs.openedx.org/en/latest/developers/how-tos/switch-to-the-sphinx-book-theme.html which gives a configuration that includes the setting. It's possible that the how-to is incorrect, or that it was correct at the time but sphinx-book-theme (now at 1.0.1) no longer supports it. In fact, only 4 repos seem to use this option, and 3 of them are on pre 1.0 versions of the theme.


Update: See openedx/docs.openedx.org#345 in which there are changes to the guide, including removal of logo_only.

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

No branches or pull requests

1 participant