Skip to content

Commit

Permalink
[doc/theme][xs]: update to latest version of the doc theme.
Browse files Browse the repository at this point in the history
  • Loading branch information
@rufuspollock
rufuspollock committed Nov 3, 2012
1 parent 97eb5f8 commit c59b304
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/_themes/sphinx-theme-okfn
Submodule sphinx-theme-okfn updated 9 files
+3 −1 README.markdown
+2 −2 layout.html
+5 −0 localtoc.html
+0 −4 static/bootstrap-css-tweaks.js
+117 −45 static/bootstrap-sphinx.css
+3 −0 static/css/bootstrap.css
+ − static/font/opensans/opensans-light-webfont.eot
+ − static/font/opensans/opensans-light-webfont.ttf
+ − static/font/opensans/opensans-light-webfont.woff

5 comments on commit c59b304

@domoritz
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rgrp Looks great but in my opinion the titles are too large for this page: http://docs.ckan.org/en/latest/common-error-messages.html
I think it makes sense to have a smaller font at least for the side bar and maybe the titles as well.

@rufuspollock
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about the titles - this is an extreme page with very long titles at very high level (if these were down one level would look better). Look at e.g. http://docs.ckan.org/en/latest/install-from-package.html for a contrast.

Re sidebar similar feelings (see alternative example) but please submit issues or pull requests on https://github.com/okfn/sphinx-theme-okfn

@domoritz
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rgrp There is a pull request for a fix. See #169.

@seanh
Copy link
Contributor

@seanh seanh commented on c59b304 Nov 14, 2012

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@domoritz Good catch. In your version, the HTML comes with the error messages in <p> tags and the explanations beneath them in <blockquote> tags. Looks slightly weird having the explanations indented blockquote style is not semantic (they aren't quotes). I think it would be better to use HTML definition lists where the error messages are the <dt> tags and the explanations the <dd> tags. It's actually really easy to do this, in the rst source file just delete the empty line between the error message and the indented explanation. e.g. this will produce a definition list with a single <dt> and a single <dd>:

``nose.config.ConfigError: Error reading config file 'setup.cfg': no such option 'with-pylons'``
   This error can result when you run nosetests for two reasons`
   1. Pylons nose plugin failed to run. If this is the case, then within a couple of lines of running `nosetests` you'll see this warning: `Unable to load plugin pylons` followed by an error message. Fix the error here first`

   2. The Python module 'Pylons' is not installed into you Python environment. Confirm this with::

       python -c "import pylons"

@domoritz
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seanh Thanks for the suggestion. I have added a commit to the pull request.

Please sign in to comment.