X-Git-Url: https://git.phdru.name/?p=sqlconvert.git;a=blobdiff_plain;f=docs%2Fconf.py;h=a224bb8f6bb8816d9b04802a62a9428a550d4440;hp=ce6f308bf7f279fe2835ae007f647623b36328a6;hb=2f9db6423abb969aada129ae752fe7aaf2499d36;hpb=16c2bcbc29f78bf54fb7ffee9577d1d88216ebbc diff --git a/docs/conf.py b/docs/conf.py index ce6f308..a224bb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# mysql2sql documentation build configuration file, created by +# sqlconvert documentation build configuration file, created by # sphinx-quickstart on Fri Jul 22 19:32:24 2016. # # This file is execfile()d with the current directory set to its @@ -16,9 +16,10 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +from datetime import date +import os +import sys +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ @@ -31,6 +32,7 @@ # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. @@ -50,18 +52,20 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'mysql2sql' -copyright = u'2016, Oleg Broytman' +project = u'sqlconvert' author = u'Oleg Broytman' +copyright = u'2016-%d, %s' % (date.today().year, author) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'0.0' +from sqlconvert.__version__ import __version__ +# The short X.Y version. +version = '.'.join(__version__.split('.')[:2]) # The full version, including alpha/beta/rc tags. -release = u'0.0.1' +release = __version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -135,7 +139,7 @@ html_theme = 'alabaster' # The name for this set of Sphinx documents. # " v documentation" by default. # -# html_title = u'mysql2sql v0.0.1' +# html_title = u'sqlconvert v0.0.1' # A shorter title for the navigation bar. Default is the same as html_title. # @@ -235,7 +239,7 @@ html_static_path = ['_static'] # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'mysql2sqldoc' +htmlhelp_basename = 'sqlconvert_doc' # -- Options for LaTeX output --------------------------------------------- @@ -261,7 +265,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'mysql2sql.tex', u'mysql2sql Documentation', + (master_doc, 'sqlconvert.tex', u'sqlconvert Documentation', u'Oleg Broytman', 'manual'), ] @@ -303,7 +307,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'mysql2sql', u'mysql2sql Documentation', + (master_doc, 'sqlconvert', u'sqlconvert Documentation', [author], 1) ] @@ -318,8 +322,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'mysql2sql', u'mysql2sql Documentation', - author, 'mysql2sql', 'One line description of project.', + (master_doc, 'sqlconvert', u'sqlconvert Documentation', + author, 'sqlconvert', 'One line description of project.', 'Miscellaneous'), ]