Merge pull request #677 from clab/add-logo

Added logo

Former-commit-id: 0282746

README.md

@@ -1,4 +1,5 @@
-# DyNet
+![DyNet](/doc/source/images/dynet_logo.png "DyNet")
+
 The Dynamic Neural Network Toolkit
 
 **News!** The master branch is now DyNet version 2.0 (as of 6/28/2017), which contains a number of changes including a new model format, etc. If you're looking for the old version, check out the [v1.1 branch](https://github.com/clab/dynet/tree/v1.1).

doc/source/citing.rst

@@ -0,0 +1,24 @@
+.. _citing:
+
+Citing/Logos
+============
+
+If you use DyNet for research, please cite our `technical report <https://arxiv.org/abs/1701.03980>`_ as follows::
+
+  @article{dynet,
+    title={DyNet: The Dynamic Neural Network Toolkit},
+    author={Graham Neubig and Chris Dyer and Yoav Goldberg and Austin Matthews and Waleed Ammar and Antonios Anastasopoulos and Miguel Ballesteros and David Chiang and Daniel Clothiaux and Trevor Cohn and Kevin Duh and Manaal Faruqui and Cynthia Gan and Dan Garrette and Yangfeng Ji and Lingpeng Kong and Adhiguna Kuncoro and Gaurav Kumar and Chaitanya Malaviya and Paul Michel and Yusuke Oda and Matthew Richardson and Naomi Saphra and Swabha Swayamdipta and Pengcheng Yin},
+    journal={arXiv preprint arXiv:1701.03980},
+    year={2017}
+  }
+
+If you want to talk about DyNet in presentations, blog posts, etc., feel free to use one of the logos below!
+
+.. image:: images/dynet_logo.png
+  :align: center
+
+.. image:: images/dynet_logo_bg.png
+  :align: center
+
+.. image:: images/dynet_logomark.png
+  :align: center

doc/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Dynet documentation build configuration file, created by
+# DyNet documentation build configuration file, created by
 # sphinx-quickstart on Thu Oct 13 16:13:12 2016.
 #
 # This file is execfile()d with the current directory set to its
@@ -53,7 +53,7 @@
 breathe_projects = {"dynet": "../doxygen/xml/"}
 breathe_default_project = "dynet"
 
-# Don't execute notebooks because it requires installing Dynet
+# Don't execute notebooks because it requires installing DyNet
 nbsphinx_execute = 'never'
 
 # Add any paths that contain templates here, relative to this directory.
@@ -69,7 +69,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Dynet'
+project = u'DyNet'
 copyright = u'2016, Clab'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -143,7 +143,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = "images/dynet_logo_white.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
@@ -202,7 +202,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Dynetdoc'
+htmlhelp_basename = 'DyNetdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -222,7 +222,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'Dynet.tex', u'Dynet Documentation',
+    ('index', 'DyNet.tex', u'DyNet Documentation',
      u'Clab', 'manual'),
 ]
 
@@ -252,7 +252,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'dynet', u'Dynet Documentation',
+    ('index', 'dynet', u'DyNet Documentation',
      [u'Clab'], 1)
 ]
 
@@ -266,8 +266,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'Dynet', u'Dynet Documentation',
-     u'Clab', 'Dynet', 'One line description of project.',
+    ('index', 'DyNet', u'DyNet Documentation',
+     u'Clab', 'DyNet', 'One line description of project.',
      'Miscellaneous'),
 ]
 

doc/source/index.rst

@@ -56,6 +56,7 @@ And we welcome your contributions!
    :maxdepth: 2
 
    contributing
+   citing