Move github template info into html_theme_options. (Feedback)

[bramwelt]

I would really like it if the sphinx_rtd_theme supported html_theme_options so that I didn't have to override breadcrumbs.html in every project I want an 'edit on github' link to show up.

This is related to: readthedocs/sphinx_rtd_theme#91

[ericholscher]

This seems reasonable. Though we probably need it in both places to make it backwards compat.

[ericholscher]

Also, any reason you can't just put the variables into html_context in your conf.py? Seems like it's the same thing?

[bramwelt]

html_context is only available on RTD.

Ah, apparently I'm not being clear. This is not for having a different github/bitbucket account than the project name. This is for projects not using RTD to build/host their documentation.

[ericholscher]

html_context is a Sphinx setting:
http://sphinx-doc.org/config.html#confval-html_context

Anyone is free to set it themselves

On Thu, Feb 27, 2014 at 9:01 AM, Trevor Bramwell
[email protected]:

html_context is only available on RTD.

Ah, apparently I'm not being clear. This is not for having a different
github/bitbucket account than the project name. This is for projects not
using RTD to build/host their documentation.

Reply to this email directly or view it on GitHubhttps://github.com//pull/681#issuecomment-36198490
.

Eric Holscher
Maker of the internet residing in Portland, Or
http://ericholscher.com

[svisser]

It seems that this html_context variable can currently only be used to augment already computed values. See: #743.

[bramwelt]

@ericholscher You are totally right about html_context. My apologies for overlooking that. I was able to get something to work using html_context. The end result looks something like this:

html_context = {
    'display_github': True,
    'github_repo': "REPO",
    'github_user': "USERNAME",
    'github_version': "master",
    'conf_py_path': "/source/"
}

Thanks, for the help!

[svisser]

@bramwelt How does that work? Your content of html_context will be overwritten in the extended conf.py (see https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl#L78 ) so your provided GitHub values will be overwritten by those in context ?

[bramwelt]

@svisser This was related to using sphinx_rtd_theme outside the context of RTD. Since the RTD doc builder is not invoked, display_github, github_repo, etc are used as-is and not overwritten.

My point in this PR was to enable me to list those options in conf.py without having to write custom templates. Using html_context is a workaround for my issue and will suffice.

[svisser]

@bramwelt thanks for clarifying that. In that case I can see how it works.