vladris/tinkerer

Allow `html_use_index`

Closed this issue · 5 comments

gdw2 commented

I'd like to enable the html_use_index option found here:

https://github.com/vladris/tinkerer/blob/master/tinkerer/__templates/conf.py#L93

Out of the box, tinkerer errors as it can't find the genindex.html template, but I copied the one over from sphinx and dropped it in the themes/boilerplate directory and it worked fine.

Would the project be opposed to me submitting a PR to allow this option?

vladris commented

Wouldn't be opposed. Just please make sure it's HTML5 compliant (though after quickly looking at genindex.html of Sphinx, seems it is). The reason I re-wrote the templates for Tinkerer was to base it on HTML5 Boilderplate and be HTML5 compliant rather than XHTML which Sphinx is using.

gdw2 commented

What's a good way to tell if a template (or page for that matter) is HTML5 compliant? Is there some tool or HTML5 validator (e.g. xmllint)?

vladris commented

I used http://validator.w3.org/, but you need a live website for it.

gdw2 commented

Submitted PR.

vladris commented

Thanks for this! If you want to give me your name, I can add you to the contributors list.