Customized and bootstrap-ifyed HTMLTranslator

demo/source/conf.py

@@ -17,7 +17,12 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 # Disabled: , 'sphinx.ext.intersphinx'
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -62,15 +67,15 @@
 #default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+show_authors = True
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -81,8 +86,21 @@
 # Enable todo output
 todo_include_todos = True
 
+autoclass_content = 'class'
+autodoc_member_order = 'bysource'
+autodoc_default_flags = [
+    'members',
+    'undoc-members',
+    'private-members',
+    # 'special-members',
+    # 'inherited-members',
+    'show-inheritance'
+]
+
 # -- Options for HTML output ---------------------------------------------------
 
+html_translator_class = 'sphinx_bootstrap_theme.BootstrapTranslator'
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 html_theme = 'bootstrap'
@@ -132,7 +150,7 @@
 
     # Location of link to source.
     # Options are "nav" (default), "footer" or anything else to exclude.
-    'source_link_position': "nav",
+    'source_link_position': "footer",
 
     # Bootswatch (http://bootswatch.com/) theme.
     #
@@ -199,7 +217,10 @@
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
-html_sidebars = {'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html']}
+html_sidebars = {
+    'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html'],
+    'examples': ['localtoc.html']
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -218,10 +239,10 @@
 #html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the

demo/source/example_module.rst

@@ -0,0 +1,8 @@
+Example Module (:mod:`ExampleModule`)
+=====================================
+
+.. automodule:: sphinx_bootstrap_theme.example_module
+    :members:
+    :undoc-members:
+    :private-members:
+    :special-members:

demo/source/examples.rst

@@ -77,6 +77,18 @@ Danger
 ------
 .. danger:: This is **danger**-ous.
 
+Attention
+---------
+.. attention:: This is a note.
+
+See Also
+--------
+.. seealso:: Probably a reference.
+
+Error
+-----
+.. error:: This is a error.
+
 Footnotes
 =========
 I have footnoted a first item [#f1]_ and second item [#f2]_.

demo/source/html_bootstrap_translator.rst

@@ -0,0 +1,8 @@
+HTML Bootstrap Translator (:mod:`html_bootstrap_translator`)
+============================================================
+
+.. automodule:: sphinx_bootstrap_theme.html_bootstrap_translator
+    :members:
+    :undoc-members:
+    :private-members:
+    :special-members:

demo/source/index.rst

@@ -22,6 +22,9 @@ Setting up and using the theme.
    examples
    sidebar
    subdir/index
+   example_module
+   html_bootstrap_translator
+
 
 Development history and feature wish lists.
 

sphinx_bootstrap_theme/__init__.py

@@ -6,7 +6,10 @@
 __version__ = ".".join(str(v) for v in VERSION)
 __version_full__ = __version__
 
+
 def get_html_theme_path():
     """Return list of HTML theme paths."""
     cur_dir = os.path.abspath(os.path.dirname(__file__))
     return [cur_dir]
+
+from sphinx_bootstrap_theme.html_bootstrap_translator import BootstrapTranslator

sphinx_bootstrap_theme/bootstrap/layout.html

@@ -14,13 +14,15 @@
   {% if theme_bootstrap_version == "3" %}
     {% set theme_css_files = theme_css_files + [
         '_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
+        '_static/font-awesome-4.0.3/css/font-awesome.min.css',
         '_static/bootstrap-sphinx.css'
       ]
     %}
   {% else %}
     {% set theme_css_files = theme_css_files + [
         '_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
         '_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
+        '_static/font-awesome-4.0.3/css/font-awesome.min.css',
         '_static/bootstrap-sphinx.css'
       ]
     %}
@@ -29,6 +31,7 @@
   {% set theme_css_files = theme_css_files + [
       '_static/bootstrap-' + bootstrap_version + '/css/bootstrap.min.css',
       '_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
+      '_static/font-awesome-4.0.3/css/font-awesome.min.css',
       '_static/bootstrap-sphinx.css'
     ]
   %}
@@ -102,7 +105,7 @@
 {%- block content %}
 {{ navBar() }}
 <div class="container">
-  <div class="row">
+  <div class="{% if theme_bootstrap_version == '3' %}row{% else %}row-fluid{% endif %}">
     {%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
     <div class="{{ bs_span_prefix }}{{ bs_content_width }}">
       {% block body %}{% endblock %}
@@ -114,28 +117,91 @@
 
 {%- block footer %}
 <footer class="footer">
-  <div class="container">
-    <p class="pull-right">
-      <a href="#">Back to top</a>
-      {% if theme_source_link_position == "footer" %}
-        <br/>
-        {% include "sourcelink.html" %}
-      {% endif %}
-    </p>
-    <p>
-    {%- if show_copyright %}
-      {%- if hasdoc('copyright') %}
-        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
-      {%- else %}
-        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
+    {% if theme_bootstrap_version == "3" %}
+      <div class="navbar navbar-default navbar-fixed-bottom" role="navigation">
+        <div class="container">
+          <div class="navbar-header">
+            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#footer-navbar-collapse">
+              <span class="sr-only">Toggle navigation</span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+            </button>
+          </div>
+          <div class="collapse navbar-collapse" id="footer-navbar-collapse">
+            <ul class="nav navbar-nav navbar-left">
+              {% if theme_source_link_position == "footer" %}
+                <li>
+                  {% include "sourcelink.html" %}
+                </li>
+              {% endif %}
+              {% if theme_navbar_sidebarrel %}
+                <li>
+                  {% include "relations.html" %}
+                </li>
+              {% endif %}
+            </ul>
+            <ul class="nav navbar-nav navbar-right">
+              <li>
+                <a href="#">
+                  <i class="fa fa-chevron-up fa-fw"></i> <span class="hidden-sm hidden-xs">Back to top</span>
+                </a>
+              </li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    {% else %}
+      <div class="navbar navbar-default navbar-fixed-bottom" role="navigation">
+        <div class="navbar-inner">
+          <div class="container">
+            <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+            <button class="btn btn-navbar" data-toggle="collapse" data-target="#footer-navbar-collapse">
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+            </button>
+
+            <div class="nav-collapse" id="footer-navbar-collapse">
+              <ul class="nav navbar-nav navbar-left">
+                {% if theme_source_link_position == "footer" %}
+                  <li>
+                    {% include "sourcelink.html" %}
+                  </li>
+                {% endif %}
+                {% if theme_navbar_sidebarrel %}
+                  <li>
+                    {% include "relations.html" %}
+                  </li>
+                {% endif %}
+              </ul>
+              <ul class="nav navbar-nav navbar-right">
+                <li>
+                  <a href="#">
+                    <i class="fa fa-chevron-up fa-fw"></i> <span class="hidden-sm hidden-xs">Back to top</span>
+                  </a>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </div>
+      </div>
+    {% endif %}
+  <div class="footer-text">
+    <p class="text-muted">
+      {%- if show_copyright %}
+        {%- if hasdoc('copyright') %}
+          {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
+        {%- else %}
+          {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
+        {%- endif %}
+      {%- endif %}
+      {%- if last_updated %}
+        {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}<br/>
+      {%- endif %}
+      {%- if show_sphinx %}
+        {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
       {%- endif %}
-    {%- endif %}
-    {%- if last_updated %}
-      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}<br/>
-    {%- endif %}
-    {%- if show_sphinx %}
-      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
-    {%- endif %}
     </p>
   </div>
 </footer>

sphinx_bootstrap_theme/bootstrap/navbar-2.html

@@ -30,11 +30,6 @@
                 {% include "navbartoc.html" %}
               {% endif %}
             {% endblock %}
-            {% if theme_navbar_sidebarrel %}
-              {% block sidebarrel %}
-                {% include "relations.html" %}
-              {% endblock %}
-            {% endif %}
             {% block navbarextra %}
             {% endblock %}
             {% if theme_source_link_position == "nav" %}

sphinx_bootstrap_theme/bootstrap/navbar.html

@@ -1,4 +1,4 @@
-  <div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top == 'true' -%} navbar-fixed-top{%- endif -%}">
+  <div id="navbar" class="{{ theme_navbar_class }} navbar-default hidden-print {% if theme_navbar_fixed_top == 'true' -%} navbar-fixed-top{%- endif -%}">
     <div class="container">
       <div class="navbar-header">
         <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
@@ -13,7 +13,7 @@
           {%- endblock %}
           {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
         </a>
-        <span class="navbar-text navbar-version pull-left"><b>{{ version|e }}</b></span>
+        <p class="navbar-text navbar-version navbar-left"><strong>{{ version|e }}</strong></p>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -30,11 +30,6 @@
                 {% include "navbartoc.html" %}
               {% endif %}
             {% endblock %}
-            {% if theme_navbar_sidebarrel %}
-              {% block sidebarrel %}
-                {% include "relations.html" %}
-              {% endblock %}
-            {% endif %}
             {% block navbarextra %}
             {% endblock %}
             {% if theme_source_link_position == "nav" %}

sphinx_bootstrap_theme/bootstrap/relations.html

@@ -2,16 +2,16 @@
 {%- if prev %}
   <li>
     <a href="{{ prev.link|e }}" title="{{ _('Previous Chapter: ') + prev.title|striptags }}">
-      {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-left visible-sm"></span>{%- endif -%}
-      <span class="hidden-sm">{{ "&laquo;"|safe }} {{ prev.title|striptags|truncate(length=16, killwords=True) }}</span>
+      <i class="fa fa-chevron-left fa-fw"></i>
+      <span class="hidden-xs">{{ prev.title|striptags|truncate(length=16, killwords=True) }}</span>
     </a>
   </li>
 {%- endif %}
 {%- if next %}
   <li>
     <a href="{{ next.link|e }}" title="{{ _('Next Chapter: ') + next.title|striptags }}">
-      {%- if theme_bootstrap_version == "3" -%}<span class="glyphicon glyphicon-chevron-right visible-sm"></span>{%- endif -%}
-      <span class="hidden-sm">{{ next.title|striptags|truncate(length=16, killwords=True) }} {{ "&raquo;"|safe }}</span>
+      <span class="hidden-xs">{{ next.title|striptags|truncate(length=16, killwords=True) }}</span>
+      <i class="fa fa-chevron-right fa-fw"></i>
     </a>
   </li>
 {%- endif %}

sphinx_bootstrap_theme/bootstrap/sourcelink.html

@@ -1,6 +1,8 @@
 {%- if show_source and has_source and sourcename %}
 <div id="sourcelink">
   <a href="{{ pathto('_sources/' + sourcename, true)|e }}"
-     rel="nofollow">{{ _('Source') }}</a>
+     rel="nofollow">
+      <i class="fa fa-code fa-fw"></i> <span class="hidden-sm hidden-xs">{{ _('Source') }}</span>
+  </a>
 </div>
 {%- endif %}