Skip to content

Commit

Permalink
Merge pull request #25 from develtech/package-meta
Browse files Browse the repository at this point in the history 
use __about__ for package metadata on docs and setup
  • Loading branch information
@hellysmile
hellysmile committed Jul 27, 2017
2 parents 11f0396 + 991654f commit 6b4de93
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 220 deletions.
8 changes: 8 additions & 0 deletions django_activeurl/__about__.py
View file
@@ -0,0 +1,8 @@
__title__ = 'django-activeurl'
__package_name__ = 'django_activeurl'
__version__ = '0.1.10'
__description__ = 'Easy to use active URL highlighting for django'
__email__ = 'hellysmile@gmail.com'
__author__ = 'hellysmile'
__license__ = 'Apache 2.0'
__copyright__ = 'Copyright 2013-2017 hellysmile'
251 changes: 38 additions & 213 deletions docs/conf.py
View file
@@ -1,242 +1,67 @@
# -*- coding: utf-8 -*-
#
# django-activeurl documentation build configuration file, created by
# sphinx-quickstart on Wed Nov 20 06:09:38 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
#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 = []

# 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'django-activeurl'
copyright = u'2013, hellysmile'

# 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 = 'master'
# The full version, including alpha/beta/rc tags.
release = 'master'

# 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']
from io import open
import os
import sys

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# Get the project root dir, which is the parent dir of this
cwd = os.getcwd()
project_root = os.path.dirname(cwd)

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
sys.path.insert(0, project_root)

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
import django_activeurl # NOQA

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# package data
about = {}
with open("../django_activeurl/__about__.py", encoding='utf-8') as fp:
exec(fp.read(), about)

# 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 = []

extensions = []

# -- Options for HTML output ---------------------------------------------------
releases_unstable_prehistory = True
releases_document_name = "history"
releases_issue_uri = "https://github.com/hellysmile/django-activeurl/issues/%s"
releases_release_uri = "https://github.com/hellysmile/django-activeurl/tree/v%s"

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
templates_path = ['_templates']

# 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 = {}
source_suffix = '.rst'

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
master_doc = 'index'

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
project = about['__title__']
copyright = about['__copyright__']

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
version = '%s' % ('.'.join(about['__version__'].split('.'))[:2])
release = '%s' % (about['__version__'])

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
exclude_patterns = ['_build']

# 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
pygments_style = 'sphinx'

# 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
htmlhelp_basename = '%sdoc' % about['__title__']

# 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 = 'django-activeurldoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# 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', 'django-activeurl.tex', u'django-activeurl Documentation',
u'hellysmile', 'manual'),
('index', '{0}.tex'.format(about['__package_name__']),
'{0} Documentation'.format(about['__title__']),
about['__author__'], 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'django-activeurl', u'django-activeurl Documentation',
[u'hellysmile'], 1)
('index', about['__package_name__'],
'{0} Documentation'.format(about['__title__']),
about['__author__'], 1),
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'django-activeurl', u'django-activeurl Documentation',
u'hellysmile', 'django-activeurl', 'One line description of project.',
'Miscellaneous'),
('index', '{0}'.format(about['__package_name__']),
'{0} Documentation'.format(about['__title__']),
about['__author__'], about['__package_name__'],
about['__description__'], 'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
intersphinx_mapping = {'http://docs.python.org/': None}
20 changes: 13 additions & 7 deletions setup.py
View file
Expand Up @@ -2,6 +2,11 @@

from setuptools import setup

about = {}
with open("django_activeurl/__about__.py", encoding='utf-8') as fp:
exec(fp.read(), about)


classifiers = '''\
Framework :: Django
Environment :: Web Environment
Expand Down Expand Up @@ -46,22 +51,23 @@ def long_description():


setup(
name='django-activeurl',
version='0.1.10',
name=about['__title__'],
version=about['__version__'],
url='https://github.com/hellysmile/django-activeurl/',
download_url='https://pypi.python.org/pypi/django-activeurl',
packages=packages,
description=description,
description=about['__description__'],
long_description=long_description(),
author='hellysmile',
author_email='hellysmile@gmail.com',
url='https://github.com/hellysmile/django-activeurl/',
author=about['__author__'],
author_email=about['__email__'],
zip_safe=False,
install_requires=[
'django',
'lxml',
'django-classy-tags',
'django_appconf',
],
license='http://www.apache.org/licenses/LICENSE-2.0',
license=about['__license__'],
classifiers=list(filter(None, classifiers.split('\n'))),
keywords=[
'django', 'url', 'link', 'active', 'css', 'templatetag', 'jinja2'
Expand Down

0 comments on commit 6b4de93

Please sign in to comment.