Document all theme options

[ericholscher]

Refs #226

We need to document how to use all of our general configuration options. I've merged this in since we don't have an existing way of handling this, but I would love if we stole the ideas alabaster has here:

https://github.com/bitprophet/alabaster#theme-options

[ghost]

I love the idea of alabaster's theme options and being able to set stuff like github_user and github_repo. When using this theme locally to show the Edit on Github link I've added

html_context = {
  "display_github": True, # Add 'Edit on Github' link instead of 'View page source'
  "github_user": "IKavanagh",
  "github_repo": project,
  "github_version": "master",
  "conf_py_path": "/doc/",
  "source_suffix": source_suffix,
}

to my conf.py file which is similar to what alabaster have done but is undocumented and probably a bit of a hack.

Their css options that you can change are different to #226. #226 changes the sass files which are compiled into css files. What alabaster do is add their variables like code_highlight to their css_t file as {{theme_code_highlight}}. Comments on a similar approach have been made in #228.

[ericholscher]

Interesting, I wonder if we can support both. I imagine the sass variables
are nicer for folks doing forks and more designy adoption, but the Sphinx
variables are useful for basic customization.

On Thu, Jul 30, 2015 at 12:29 PM, Ian Kavanagh notifications@github.com
wrote:

I love the idea of alabaster's theme options and being able to set stuff
like github_user and github_repo. When using this theme locally to show
the Edit on Github link I've added

html_context = {
"display_github": True, # Add 'Edit on Github' link instead of 'View page source'
"github_user": "IKavanagh",
"github_repo": project,
"github_version": "master",
"conf_py_path": "/doc/",
"source_suffix": source_suffix,
}

to my conf.py file which is similar to what alabaster have done but is
undocumented and probably a bit of a hack.

Their css options that you can change are different to #226
#226. #226
#226 changes the sass
files which are compiled into css files. What alabaster do is add their
variables like code_highlight to their css_t file as
{{theme_code_highlight}}. Comments on a similar approach have been made
in #228 #228.

—
Reply to this email directly or view it on GitHub
#231 (comment)
.

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

[Blendify]

Where should we document this? https://github.com/rtfd/readthedocs.org/tree/master/docs create a wiki page in this repo? in the readme?

[ericholscher]

Probably in the README for now.

…

On Thursday, March 9, 2017, Aaron ***@***.***> wrote: Where should we document this? https://github.com/rtfd/ readthedocs.org/tree/master/docs create a wiki page in this repo? in the readme? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#231 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABjpr0zvsqZedctInrCpyVJVNgwNThEks5rkKVRgaJpZM4Fi-QN> .

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