From d1abe10349f145b369847765ba6e42e1c3593593 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Sun, 1 Jun 2014 00:17:57 +0200 Subject: [PATCH] add release plugin and changelog --- .gitignore | 1 + docs/changelog.rst | 5 +++++ docs/conf.py | 32 +++++++++++++++++++------------- docs/index.rst | 2 +- requirements/local.txt | 1 + 5 files changed, 27 insertions(+), 14 deletions(-) create mode 100644 docs/changelog.rst diff --git a/.gitignore b/.gitignore index 5f8ae64..f25647b 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,4 @@ Desktop.ini .ropeproject/ htmlcov/ tags +_build/ diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..9826f7d --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,5 @@ +Changelog +========= + +* :feature:`-` initial model code for os users +* :feature:`-` initial model code for mail address and mailbox management diff --git a/docs/conf.py b/docs/conf.py index 72bbeb9..228b845 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,5 @@ # -*- coding: utf-8 -*- +# pymode:lint_ignore=E501 # # gnuviechadmin documentation build configuration file, created by # sphinx-quickstart on Sun May 18, 2014. @@ -12,7 +13,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +#import sys +#import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -26,7 +28,11 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = ['releases', 'sphinx.ext.autodoc', 'celery.contrib.sphinx'] + +# configuration for releases extension +releases_issue_uri = 'https://dev.gnuviech-server.de/gva/ticket/%s' +releases_release_uri = 'https://dev.gnuviech-server.de/gva/milestone/%s' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -171,21 +177,21 @@ htmlhelp_basename = 'gnuviechadmindoc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'gnuviechadmin.tex', u'gnuviechadmin Documentation', - u'Jan Dittberner', 'manual'), + ('index', 'gnuviechadmin.tex', u'gnuviechadmin Documentation', + u'Jan Dittberner', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -228,9 +234,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'gnuviechadmin', u'gnuviechadmin Documentation', - u'Jan Dittberner', 'gnuviechadmin', 'Customer center for gnuviech servers.', - 'Miscellaneous'), + ('index', 'gnuviechadmin', u'gnuviechadmin Documentation', + u'Jan Dittberner', 'gnuviechadmin', 'Customer center for gnuviech servers.', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. diff --git a/docs/index.rst b/docs/index.rst index 99ec616..425bea4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ Contents: install deploy tests - + changelog Indices and tables diff --git a/requirements/local.txt b/requirements/local.txt index 644abf3..a81214d 100644 --- a/requirements/local.txt +++ b/requirements/local.txt @@ -3,3 +3,4 @@ coverage==3.7.1 django-debug-toolbar==1.2.1 Sphinx==1.2.2 +releases==0.6.1