Browse Source

add favicon

Mark Slatem 10 years ago
parent
commit
ff4ffd2a1e
2 changed files with 12 additions and 2 deletions
  1. 2 1
      source/conf.py
  2. 10 1
      source/doc-guide.rst

+ 2 - 1
source/conf.py

@@ -122,12 +122,13 @@ html_theme_path = ["_themes", ]
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = "_static/images/logo.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #html_favicon = None
+html_favicon = "_static/images/favicon.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

+ 10 - 1
source/doc-guide.rst

@@ -27,7 +27,15 @@ This entire document is written with the RST syntax. In the right sidebar, you s
 Getting Started
 ###############
 
-Learn Git in 15 Minutes `Git Tutorial`_ that will help you get started if you prefer. Here is the link on installing Git if you don't have it yet `Git Install`_
+Getting Git Right
+==================
+
+Learn Git in 15 Minutes `Git Tutorial`_ that will help you get started if you prefer. There is also awesome Git Tutorials on the `Atlassian Git site`_. Here is the link on installing Git if you don't have it yet `Git Install`_
+
+Setting up the Docs Locally
+===============================
+
+One of the great things about Git and documentation is that all people who contribute are encouraged to setup their own local copy of the docs for off-line editing. This by default will ensure that many backups of the documents exist and there is never any concern about losing them.
 
 Assuming you have Python_ already, install Sphinx locally::
 
@@ -953,3 +961,4 @@ Similarly to the note directive, one can include todo boxes but it requires the
 
 .. _Git Tutorial: https://try.github.io/levels/1/challenges/1
 .. _Git Install: http://git-scm.com/book/en/Getting-Started-Installing-Git
+.. _Atlassian Git site: https://www.atlassian.com/git/tutorials