Browse Source

Added sidebarintro.

sh4nks 11 years ago
parent
commit
76e8da3917
3 changed files with 25 additions and 1 deletions
  1. 12 0
      docs/_templates/sidebarintro.html
  2. 5 1
      docs/conf.py
  3. 8 0
      docs/index.rst

+ 12 - 0
docs/_templates/sidebarintro.html

@@ -0,0 +1,12 @@
+<h3>About</h3>
+<p>
+  FlaskBB is forum software built with Flask. You can very easy create
+  new topics, posts and send other users private messages. It also includes
+  basic administration and moderation tools.
+</p>
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="http://flaskbb.org">FlaskBB Website</a></li>
+  <li><a href="https://github.com/sh4nks/flaskbb">FlaskBB @ github</a></li>
+  <li><a href="https://github.com/sh4nks/flaskbb/issues">Issue Tracker</a></li>
+</ul>

+ 5 - 1
docs/conf.py

@@ -147,7 +147,11 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 #html_use_smartypants = True
 
 
 # Custom sidebar templates, maps document names to template names.
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    'index':    ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
+    '**':       ['localtoc.html', 'relations.html',
+                 'sourcelink.html', 'searchbox.html']
+}
 
 
 # Additional templates that should be rendered to pages, maps page names to
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 # template names.

+ 8 - 0
docs/index.rst

@@ -5,4 +5,12 @@ Welcome to FlaskBB's documentation!
 
 
 FlaskBB is a lightweight forum software in Flask.
 FlaskBB is a lightweight forum software in Flask.
 
 
+
+Links
+-----
+
+`documentation <http://flaskbb.readthedocs.org/en/latest/index.html/>`_
+| `source <http://github.com/sh4nks/flaskbb>`_
+
+
 .. include:: contents.rst.inc
 .. include:: contents.rst.inc