1# Boundless Read the Docs Theme 2 3Operates as an extension of ``sphinx_rtd_theme`` originated by Boundless 4 5Reference: 6 7* https://github.com/rtfd/sphinx_rtd_theme 8 9## Configuration 10 11Configuration options provided by ``boundess_rtd`: 12 13``` 14html_theme_options = { 15 'display_connect': False #Ask a Question 16} 17``` 18 19Configuration options provided by `sphinx_rtd_theme`: 20 21``` 22html_theme_options = { 23 'canonical_url': '', 24 'analytics_id': '', 25 'logo_only': False, 26 'display_version': True, 27 'prev_next_buttons_location': 'both', 28 'style_external_links': True, 29 'vcs_pageview_mode': '', 30 # Toc options 31 'collapse_navigation': False, 32 'sticky_navigation': True, 33 'navigation_depth': 3, 34 'includehidden': True, 35 'titles_only': False 36} 37``` 38 39For the navigation bar to work correctly be sure to include captions in your `tocreee` definitions. 40 41## Implementation 42 43Care is taken to override the `sphinx_rtd_theme` CSS settings as required, rather than duplicate the files. This approach allows us to update `sphinx_rtd_theme` over time to take advantage features and fixes. 44 45The following is an outline of `boundless_rtd` contents: 46 47* static/css/boundless.css - provides font selection and overrides branding elements 48* static/fonts/proximanova-* 49* static/fonts/sourcecodepro-* 50* static/img/boundless-logo-32.png 51* static/img/powered-by-boundless*.png 52* static/js/ 53