Takayuki KONDO avatar Takayuki KONDO committed 6edbeb5

setup package and tox

Comments (0)

Files changed (11)

+include README
+include LICENSE
+include CHANGES.*
+==================================
+Mercurial extension for Sphinx
+==================================
+
+Overview
+========
+
+This allows you to include a Mercurial extension of your Sphinx documentation
+within the documentation.
+
+How to use
+===========
+
+To use it, add 'sphinx_hg' to 'extensions' in your Sphinx conf.py, and add:
+
+.. hg_changelog::
+
+where you want the list of commits to appear.
+
+Options
+=============
+
+repo_root_path
+  specify repository root (default: ".")
+max_commits
+  set max commits to include (default: 10)
+branch
+  specify which branch to include (default: "default")
+path
+  specify the path to include (default: all)
+
+  NOTE: you need to set from repository root.
+
+Example
+===========
+
+::
+
+  .. hg_changelog::
+     :repo_root_path: ../..
+     :max_commits: 2
+     :path: test/rst
+
+Acknowledgement
+================
+https://github.com/OddBloke/sphinx-git
+

README.rst

-==================================
-Mercurial extension for Sphinx
-==================================
-
-Overview
-========
-
-This allows you to include a Mercurial changelog of your Sphinx documentation
-within the documentation.
-
-How to use
-===========
-
-To use it, add 'sphinx_hg' to 'extensions' in your Sphinx conf.py, and add:
-
-.. hg_changelog::
-
-where you want the list of commits to appear.
-
-Options
-=============
-
-repo_root_path
-  specify repository root (default: ".")
-max_commits
-  set max commits to include (default: 10)
-branch
-  specify which branch to include (default: "default")
-path
-  specify the path to include (default: all)
-
-  NOTE: you need to set from repository root.
-
-Example
-===========
-
-::
-
-  .. hg_changelog::
-     :repo_root_path: ../..
-     :max_commits: 2
-     :path: test/rst
-
-Acknowledgement
-================
-https://github.com/OddBloke/sphinx-git
-

Empty file added.

+# -*- coding: utf-8 -*-
+import sys, os
+
+#print sys.path
+
+sys.path.insert(0, os.path.abspath('../'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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 += ['sphinxcontrib.hg_changelog']
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxcontrib.mercurial'
+copyright = u'2012, Takayuki KONDO'
+
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# 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
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sphinxcontrib-mercurial-doc'
+
+
+# nothing
+.. -*- coding: utf-8 -*-
+
+Welcome to sphinxcontrib-mercurial's documentation!
+===================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+
+Changelog
+============
+- default
+   .. hg_changelog::
+
+- option (last 3commits about index.rst)
+   .. hg_changelog::
+      :max_commits: 3
+      :repo_root_path: .
+      :path: index.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''
+# -*- coding: utf-8 -*-
+
+from setuptools import setup, find_packages
+
+long_desc = open('README').read()
+
+requires = ['Sphinx>=0.6', 'mercurial>=1.8' ]
+
+setup(
+    name='sphinxcontrib-mercurial',
+    version='0.1',
+    url='http://bitbucket.org/cointoss1973/sphinxcontrib-merurial',
+    download_url='http://pypi.python.org/pypi/sphinxcontrib-mercurial',
+    license='GPLv3',
+    author='Takayuki KONDO',
+    author_email='tkondou@gmail.com',
+    description='Sphinx "mercurial" extension',
+    long_description=long_desc,
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GPLv3 License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Documentation',
+        'Topic :: Utilities',
+    ],
+    platforms='any',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requires,
+    namespace_packages=['sphinxcontrib'],
+)

sphinxcontrib/__init__.py

     This package is a namespace package that contains all extensions
     distributed in the ``sphinx-contrib`` distribution.
 
-    :copyright: Copyright 2007-2012 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
 
 __import__('pkg_resources').declare_namespace(__name__)
+
+[tox]
+envlist=py27, sphinx06, hg18
+
+[testenv]
+deps=
+    nose
+    Sphinx
+    mercurial
+setenv=
+    HGRCPATH=doc/hgrc
+commands = 
+    sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
+
+
+[testenv:sphinx06]
+deps=
+    nose
+    Sphinx==0.6
+    mercurial
+
+[testenv:hg18]
+deps=
+    nose
+    Sphinx
+    mercurial==1.8
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.