added quickstart to toc, modified conf.py

cecid · Jan 18, 2017 · a0e31f8 · a0e31f8
1 parent 060cb3d
commit a0e31f8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -48,7 +48,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Hermes 2+ Documentation'
+project = u'Hermes Business Messaging Gatweay Documentation'
 copyright = u'2016, CECID, HKU'
 author = u'CECID'
 
@@ -233,7 +233,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'mydocsdoc'
+htmlhelp_basename = 'hermes_docs'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -259,7 +259,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'hermes.tex', u'Hermes 2+ Documentation',
+    (master_doc, 'hermes_docs.tex', u'Hermes Documentation',
      u'CECID', 'manual'),
 ]
 
@@ -301,7 +301,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'mydocs', u'my docs Documentation',
+    (master_doc, 'hermes_docs', u'my docs Documentation',
      [author], 1)
 ]
 
@@ -316,8 +316,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'mydocs', u'my docs Documentation',
-     author, 'mydocs', 'One line description of project.',
+    (master_doc, 'hermes_docs', u'Hermes Business Messaging Gateway Documentation',
+     author, 'hermes_docs', 'Documentation of Hermes Business Messaging Gateway',
      'Miscellaneous'),
 ]
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -47,6 +47,7 @@ Technical documents
 .. toctree::
    :maxdepth: 2
 
+   quickstart
    installation
    configuration
    application
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst