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

Re-implement esbonio.sphinx.configOverrides #870

Merged
merged 5 commits into from
Aug 6, 2024

Conversation

alcarney
Copy link
Member

@alcarney alcarney commented Aug 6, 2024

The brings back the sphinx.configOverrides option from the 0.x version of esbonio, offering a convenient way to override parts of a project's conf.py file

{
    "esbonio": {
        "sphinx": {
            "pythonCommand": ["/path/to/venv/bin/python"],
            "buildCommand": ["sphinx-build", "-M", "dirhtml", "docs/", "docs/_build"],
            "configOverrides": {
                "html_theme": "alabaster",
                "html_theme_options": {},
            }
        }
    }
}

Closes #785

Nothing against furo, but not depending on it for test cases is one
less dependency to migrate when a major version of Sphinx rolls
around.

Plus overriding the theme set in `conf.py` is a nice way to exercise
the `configOverrides` option
@alcarney alcarney merged commit d1ace34 into swyddfa:develop Aug 6, 2024
13 of 14 checks passed
@alcarney alcarney deleted the config-override branch August 6, 2024 22:22
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.

Re-implement sphinx.configOverrides
1 participant