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
using sphinx-book-theme-1.0.0 requires repository_provider #1964
Comments
Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗 |
This is also an issue when using a URL for a GitHub organisation (e.g. see the build error here). This arises from this line in For example, for my repo: repo_url = "https://quantitative-environmental-science.github.io/Notes/"
provider_url, org, repo = repo_url.strip("/").rsplit("/", 2)
provider_url
> 'https:/' Which is invalid. Happy to specify
None worked... |
Just did some more digging into the issue, since we encountered it as well. I took a look at the when trying out all of the following: repository:
repository_provider: github
provider: github
html:
repository_provider: github
provider: github No matter what I try, The underlying Note however, the |
To explain what's going on here, Jupyter Book's sphinx:
recursive_update: true
config:
html_theme_options:
repository_provider: custom The recursive update just means that we don't clobber the existing settings. This maps onto the settings in this section: https://sphinx-book-theme.readthedocs.io/en/stable/components/source-files.html#manually-specify-the-provider |
Seems to work. Is there any chance this will be integrated in the |
I got it working by specifying |
the following worked for me (using a custom gitlab repository) in the config.yml file: sphinx:
recursive_update: true
config:
html_theme_options:
repository_provider: https://my.provider.com
html_context:
gitlab_url: https://my.provider.com/my
gitlab_repo: repository
gitlab_user: ""
gitlab_version: main
doc_path: source
repository:
url: https://my.provider.com/my/repository It' basically the same as agoose77 proposed, but I also had to set the html_context otherwise I would get
|
Building the Jupyter Book as HTML newly requires a
repository_provider
to add GitLab-Buttons.How to add that? The documentation misses such a setting.
Our configuration is
which then causes
This worked before the release v0.15.0.
Versions:
The text was updated successfully, but these errors were encountered: