From 8f8af6ab1d828d557dad61375eb520f3f12ad496 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tarek=20Ziad=C3=A9?= Date: Fri, 17 Jul 2009 14:38:02 +0200 Subject: moved the docs in one single dir --HG-- branch : distribute extra : rebase_source : 55ccc499af54a290bd912072dae61e7c8c05736c --- docs/conf.py | 190 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 docs/conf.py (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..74bc7a6c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,190 @@ +# -*- coding: utf-8 -*- +# +# Distribute documentation build configuration file, created by +# sphinx-quickstart on Fri Jul 17 14:22:37 2009. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# 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 your extensions are in another directory, add it here. If the directory +# is relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +#sys.path.append(os.path.abspath('.')) + +# General configuration +# --------------------- + +# 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 = '.txt' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Distribute' +copyright = u'2009, The fellowship of the packaging' + +# 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 = '0.6' +# The full version, including alpha/beta/rc tags. +release = '0.6' + +# 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 documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = [] + +# 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' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default.css' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. +#html_copy_source = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Distributedoc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +latex_documents = [ + ('index', 'Distribute.tex', ur'Distribute Documentation', + ur'The fellowship of the packaging', '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 + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True -- cgit v1.2.1 From 6c31d16ce512c164e211aec0fa1d44437dfe5c61 Mon Sep 17 00:00:00 2001 From: tarek Date: Tue, 25 Aug 2009 19:48:02 +0200 Subject: added change note + raise version --HG-- branch : distribute extra : rebase_source : dbba2f1fa3d5292746b9605a906e67c9373c7910 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 74bc7a6c..d4ff4a15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,9 +49,9 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6' +version = '0.6.1' # The full version, including alpha/beta/rc tags. -release = '0.6' +release = '0.6.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 079951a1532a2c9e3295253c65e06091758f9150 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 8 Oct 2009 15:10:08 +0200 Subject: Updated Sphinx config, e.g. to add theme support --HG-- branch : distribute extra : rebase_source : b23e8bc5fa516fc6d0a2b232127c9d8b43cdb067 --- docs/conf.py | 51 +++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 22 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d4ff4a15..bad1a578 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,20 +16,19 @@ import sys, os -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. +# 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.append(os.path.abspath('.')) -# General configuration -# --------------------- +# -- General configuration ----------------------------------------------------- # 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'] +templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.txt' @@ -49,9 +48,9 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.1' +version = '0.6.4' # The full version, including alpha/beta/rc tags. -release = '0.6.1' +release = '0.6.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -87,21 +86,30 @@ exclude_trees = [] # 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 style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'nature' + +# 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 = ['_theme'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +html_title = "Distribute documentation" # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +html_short_title = "Distribute" # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -115,7 +123,7 @@ html_style = 'default.css' # 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'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -141,8 +149,8 @@ html_static_path = ['.static'] # If true, the index is split into individual pages for each letter. #html_split_index = False -# If true, the reST sources are included in the HTML build as _sources/. -#html_copy_source = True +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -156,8 +164,7 @@ html_static_path = ['.static'] htmlhelp_basename = 'Distributedoc' -# Options for LaTeX output -# ------------------------ +# -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -166,7 +173,7 @@ htmlhelp_basename = 'Distributedoc' #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class [howto/manual]). +# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Distribute.tex', ur'Distribute Documentation', ur'The fellowship of the packaging', 'manual'), -- cgit v1.2.1 From 009a483d58c57a15f469232daa0de302a877d186 Mon Sep 17 00:00:00 2001 From: tarek Date: Sun, 11 Oct 2009 11:22:25 +0200 Subject: starting 0.6.5 --HG-- branch : distribute extra : rebase_source : 6925947fb2b7beef652eef8a2683cae710f46e58 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index bad1a578..f7e762eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.4' +version = '0.6.5' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From 23229041ce73c90615ecefa80a720da785cd54cd Mon Sep 17 00:00:00 2001 From: tarek Date: Thu, 15 Oct 2009 22:23:24 +0200 Subject: starting 0.6.6 --HG-- branch : distribute extra : rebase_source : 15b88555dec253c490ee91a6e71ec1c945fdf6b0 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f7e762eb..a0506322 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.5' +version = '0.6.6' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From fa9206561cd5483846b86c89206ced48d502018b Mon Sep 17 00:00:00 2001 From: tarek Date: Fri, 16 Oct 2009 12:11:24 +0200 Subject: starting 0.6.7 --HG-- branch : distribute extra : rebase_source : c4445b08d41ce91b2a7c03793110b07113edd9ea --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a0506322..794e728c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.6' +version = '0.6.7' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From 1b6bf2620558a3a4f793827393017ddf5ba6a323 Mon Sep 17 00:00:00 2001 From: tarek Date: Sun, 1 Nov 2009 15:06:06 +0100 Subject: started 0.6.8 --HG-- branch : distribute extra : rebase_source : 744dff4dd47fbc1c7fd8d482faa55f20f43e5843 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 794e728c..4c44b25d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.7' +version = '0.6.8' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From f7a2000adabf8cca6bc691b6c946ccdbb0c81749 Mon Sep 17 00:00:00 2001 From: tarek Date: Sun, 1 Nov 2009 20:21:40 +0100 Subject: started 0.6.9 --HG-- branch : distribute extra : rebase_source : 2064f9b14f740b9dbd4bcfa61584d3667471d8d2 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4c44b25d..4f13d857 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.8' +version = '0.6.9' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From 6b23a07b6263fe86a7e1cdd790e850508e8d1530 Mon Sep 17 00:00:00 2001 From: tarek Date: Wed, 11 Nov 2009 22:11:02 +0100 Subject: added a side bar with a download link to the doc. fixes #89 --HG-- branch : distribute extra : rebase_source : 30b018e5e29225e00ffcb311af2cd0d4ad6eed6c --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4f13d857..74435672 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -134,7 +134,8 @@ html_short_title = "Distribute" #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = {'index': 'indexsidebar.html'} + # Additional templates that should be rendered to pages, maps page names to # template names. -- cgit v1.2.1 From e651ea7e2583bf40f129a4d1b82a93d0de60c291 Mon Sep 17 00:00:00 2001 From: tarek Date: Sat, 12 Dec 2009 13:19:56 +0100 Subject: starting 0.6.10 development --HG-- branch : distribute extra : rebase_source : 47ee1886e326219ded82d6d9fc8412bdec62e03d --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 74435672..79ada8cb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.9' +version = '0.6.10' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From 93b983e6f2302007cedbf44bcf0b944415c05361 Mon Sep 17 00:00:00 2001 From: tarek Date: Sat, 12 Dec 2009 15:22:47 +0100 Subject: starting 0.6.11 --HG-- branch : distribute extra : rebase_source : e69bd36f08c0407a0e818e67e5a5b7d633182a57 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 79ada8cb..c9f8fef7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.10' +version = '0.6.11' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From 4570438396d4ee5fe1255b39e2e6070b2e69a424 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Sun, 13 Dec 2009 12:50:37 +0100 Subject: Updated docs theme for higher readability --HG-- branch : distribute extra : rebase_source : ae453d7b4b32d8823d57ebe411eaf53e050ad9dd --- docs/conf.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c9f8fef7..3991c73c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -131,21 +131,20 @@ html_short_title = "Distribute" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +html_use_smartypants = True # Custom sidebar templates, maps document names to template names. html_sidebars = {'index': 'indexsidebar.html'} - # 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_use_modindex = True +html_use_modindex = False # If false, no index is generated. -#html_use_index = True +html_use_index = False # If true, the index is split into individual pages for each letter. #html_split_index = False -- cgit v1.2.1 From 43329058964f3021d997b8e2b35d3fec913e7692 Mon Sep 17 00:00:00 2001 From: Tarek Ziade Date: Thu, 6 May 2010 17:47:03 +0200 Subject: starting 0.6.12 --HG-- branch : distribute extra : rebase_source : 206e8a982bbd49a697579b98d6728a0a61bfd31c --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3991c73c..42a072fe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.11' +version = '0.6.12' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From de6e3bcc3c77bff17a6609b31bc1b6a9212bbd88 Mon Sep 17 00:00:00 2001 From: Tarek Ziade Date: Thu, 6 May 2010 23:14:00 +0200 Subject: raised the revision --HG-- branch : distribute extra : rebase_source : 294117170d32ada89385db57b12e25ab2fbb8523 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 42a072fe..53614ed5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.12' +version = '0.6.13' # The full version, including alpha/beta/rc tags. release = '0.6.4' -- cgit v1.2.1 From c4318e2572b0158aa05fa241b85552073bb8400b Mon Sep 17 00:00:00 2001 From: Tarek Ziade Date: Mon, 31 May 2010 19:39:15 +0200 Subject: starting 0.6.14 --HG-- branch : distribute extra : rebase_source : b9e623ce0a5b70680f18c48e1c5f64753b70d38c --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 53614ed5..59443dd1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.13' +version = '0.6.14' # The full version, including alpha/beta/rc tags. -release = '0.6.4' +release = '0.6.14' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 1e31cb66948b5306364b453bccada467408870ec Mon Sep 17 00:00:00 2001 From: Tarek Ziade Date: Thu, 15 Jul 2010 02:47:08 +0200 Subject: 0.6.15 is starting --HG-- branch : distribute extra : rebase_source : 900799106c9cd4ce9c0dc4db4c3b137147a35776 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 59443dd1..2bf4d37e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.14' +version = '0.6.15' # The full version, including alpha/beta/rc tags. -release = '0.6.14' +release = '0.6.15' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 5ad4feb46a452280651cb7f6411bbaacb6b6466d Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 15 Mar 2011 12:32:24 -0400 Subject: Bumped version numbers to 0.6.16 Updated copyright to include 2010,2011. --HG-- branch : distribute extra : rebase_source : b8fc0374e3cdedf002f66c6b1b1fb5e0d378323d --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 2bf4d37e..f3bd26da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,16 +41,16 @@ master_doc = 'index' # General information about the project. project = u'Distribute' -copyright = u'2009, The fellowship of the packaging' +copyright = u'2009-2011, The fellowship of the packaging' # 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 = '0.6.15' +version = '0.6.16' # The full version, including alpha/beta/rc tags. -release = '0.6.15' +release = '0.6.16' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From dba705d9f2ffb25b4ecf293604b01dbcf88c6d7c Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 30 Apr 2011 09:14:15 -0400 Subject: Bumped working revisions to 0.6.17 --HG-- branch : distribute extra : rebase_source : 0d0c60865356a460ec83f3d4554cf9cd522ec8a1 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f3bd26da..e52891fe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.16' +version = '0.6.17' # The full version, including alpha/beta/rc tags. -release = '0.6.16' +release = '0.6.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 64cbfc7a171da28d6688356e27ae470b7ac41341 Mon Sep 17 00:00:00 2001 From: guyroz Date: Thu, 22 Sep 2011 18:56:33 +0300 Subject: bumped revision --HG-- branch : distribute extra : rebase_source : 8ed8b565fc2a32f8da055ec9892a5a34daf6a24f --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e52891fe..601ac6ab 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.17' +version = '0.6.23' # The full version, including alpha/beta/rc tags. -release = '0.6.17' +release = '0.6.23' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 8372d395c718cf17a144eb6db314832eb86582e9 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 14 Oct 2011 11:50:26 -0400 Subject: Bumped to 0.6.24 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 91a4d836ff8a34f433a37f838ec78408ace2aee7 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 601ac6ab..65ee57be 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.23' +version = '0.6.24' # The full version, including alpha/beta/rc tags. -release = '0.6.23' +release = '0.6.24' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From a119995b29457b2e4dffddd798faa320c257f32b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 14 Oct 2011 12:24:25 -0400 Subject: Bumped to 0.6.25 in preparation for next release. --HG-- branch : distribute extra : rebase_source : f6e1463807528017b439623835cdeaf07bc1369a --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 65ee57be..e4bd76af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.24' +version = '0.6.25' # The full version, including alpha/beta/rc tags. -release = '0.6.24' +release = '0.6.25' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 7c0eeec316a6d593b7c868c96dfe1b96fb8775b2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 9 Mar 2012 23:15:44 -0800 Subject: Bumped to 0.6.26 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 3320fd7793afe7e4cc452ece99407e23c95b7a51 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e4bd76af..80d8c0e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.25' +version = '0.6.26' # The full version, including alpha/beta/rc tags. -release = '0.6.25' +release = '0.6.26' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From a17a1c96caac7e6d602a750281dae564c56568cc Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 7 Apr 2012 22:24:01 -0400 Subject: Bumped to 0.6.27 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 0addbfe4e10e6ce8b94bf4b2916079bce91bca7f --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 80d8c0e1..5312272f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.26' +version = '0.6.27' # The full version, including alpha/beta/rc tags. -release = '0.6.26' +release = '0.6.27' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 7b49853cb59e15b9c7432584bc57f18b38845333 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 18 May 2012 15:46:40 -0400 Subject: Bumped to 0.6.28 in preparation for next release. --HG-- branch : distribute extra : rebase_source : eb9a0f08f4b371984517f556638682828e7048b1 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 5312272f..e7011e26 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.27' +version = '0.6.28' # The full version, including alpha/beta/rc tags. -release = '0.6.27' +release = '0.6.28' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From be5acb407cfa5dd1ff37ac1ed68d96ba92302cc2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 22 Jul 2012 16:58:22 -0400 Subject: Bumped to 0.6.29 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 44417a6112b166bdfa875da05254ba206ef34cab --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e7011e26..7b82a884 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.28' +version = '0.6.29' # The full version, including alpha/beta/rc tags. -release = '0.6.28' +release = '0.6.29' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From ae5c5639d3704b1c4caece39839b6135fe8381b7 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 21 Oct 2012 04:01:36 -0400 Subject: Bumped to 0.6.30 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 2181b40073d9790f489b692900f53c5efb3c34cd --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 7b82a884..e6cfdca0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.29' +version = '0.6.30' # The full version, including alpha/beta/rc tags. -release = '0.6.29' +release = '0.6.30' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 69fa64f972dc95b9e9bb583229e20bb117fb7102 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 22 Oct 2012 06:03:05 -0400 Subject: Bumped to 0.6.31 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 74ac06a235b4d51a69d5be1c494bf922c8093072 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e6cfdca0..08fa643d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.30' +version = '0.6.31' # The full version, including alpha/beta/rc tags. -release = '0.6.30' +release = '0.6.31' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 40102f07a08808c2c356891608fd201ee02e618b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 24 Nov 2012 23:04:02 -0500 Subject: Bumped to 0.6.32 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 107cb8e68f5d9d947096d0733e841ba568df0be2 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 08fa643d..c1417e77 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.31' +version = '0.6.32' # The full version, including alpha/beta/rc tags. -release = '0.6.31' +release = '0.6.32' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 1c2dff7451101c9cfb37e4ae16eb23ef17332f5a Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 26 Nov 2012 12:18:36 -0500 Subject: Bumped to 0.6.33 in preparation for next release. --HG-- branch : distribute extra : rebase_source : cbb90a165b1e410ac7998fe5a57f0c84e9c024d3 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c1417e77..af26376e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.32' +version = '0.6.33' # The full version, including alpha/beta/rc tags. -release = '0.6.32' +release = '0.6.33' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 2a3d28cf5fed225bfe2c3f95dfbf61c2d23fd6c4 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 29 Dec 2012 17:10:54 -0500 Subject: Bumped to 0.6.34 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 4455898775fbb40a5a331909c61d45622a9ea97a --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index af26376e..15226651 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.33' +version = '0.6.34' # The full version, including alpha/beta/rc tags. -release = '0.6.33' +release = '0.6.34' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 9e26a920ffd60595ed80f1c4e6f4bdd49507c0f2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 31 Dec 2012 10:27:51 -0500 Subject: Bumped to 0.6.35 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 77f34fdeebd01224a2d399855f0674108133b3e6 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 15226651..98380ba9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.34' +version = '0.6.35' # The full version, including alpha/beta/rc tags. -release = '0.6.34' +release = '0.6.35' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 1e7b49282e6f36d5d624bdf50f1ea9a34f52cfee Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 16 Feb 2013 03:12:35 -0500 Subject: Bumped to 0.6.36 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 82ea3f25bc7836db7398b0e602ef34baa1f2c34e --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 98380ba9..586e3fe6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.35' +version = '0.6.36' # The full version, including alpha/beta/rc tags. -release = '0.6.35' +release = '0.6.36' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 890c8b348838b24d9eaa1725dcf858021f54d88d Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 1 Mar 2013 12:20:57 -0500 Subject: Updated documentation to reflect merged target name, only keeping legacy references to Distribute. --HG-- branch : Setuptools-Distribute merge extra : source : 7c68dd2a22cf2dc0ad77f1cca857736586aa5753 --- docs/conf.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 586e3fe6..4f878f64 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# Distribute documentation build configuration file, created by +# Setuptools documentation build configuration file, created by # sphinx-quickstart on Fri Jul 17 14:22:37 2009. # # This file is execfile()d with the current directory set to its containing dir. @@ -40,8 +40,8 @@ source_suffix = '.txt' master_doc = 'index' # General information about the project. -project = u'Distribute' -copyright = u'2009-2011, The fellowship of the packaging' +project = u'Setuptools' +copyright = u'2009-2013, The fellowship of the packaging' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -106,10 +106,10 @@ html_theme_path = ['_theme'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = "Distribute documentation" +html_title = "Setuptools documentation" # A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = "Distribute" +html_short_title = "Setuptools" # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -161,7 +161,7 @@ html_use_index = False #html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'Distributedoc' +htmlhelp_basename = 'Setuptoolsdoc' # -- Options for LaTeX output -------------------------------------------------- @@ -175,7 +175,7 @@ htmlhelp_basename = 'Distributedoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'Distribute.tex', ur'Distribute Documentation', + ('index', 'Setuptools.tex', ur'Setuptools Documentation', ur'The fellowship of the packaging', 'manual'), ] -- cgit v1.2.1 From db6d5f7ac474fa0605213514e793f98a0157a2ab Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 5 Apr 2013 17:14:51 -0400 Subject: Bumped to 0.6.37 in preparation for next release. --HG-- branch : distribute extra : rebase_source : a59fcbbf5ca73fb41958d42d33d3de299ad9ae7c --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 586e3fe6..0a943a16 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.36' +version = '0.6.37' # The full version, including alpha/beta/rc tags. -release = '0.6.36' +release = '0.6.37' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From a34e56cef2e2cb2aea3d4ff5b532949d426e3b97 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 4 May 2013 22:10:00 -0400 Subject: Bumped to 0.6.38 in preparation for next release. --HG-- branch : distribute extra : rebase_source : cf2ffa52b8e0cf1403b4e8ca23921a4cda51ba5b --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 0a943a16..b5dc23bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.37' +version = '0.6.38' # The full version, including alpha/beta/rc tags. -release = '0.6.37' +release = '0.6.38' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 878a81c62061ab506ed1874d541cbeb714fe06fe Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 5 May 2013 08:45:43 -0400 Subject: Bumped to 0.6.39 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 3e627b0d100b8ae32e8dc995f2da0003bbd9c605 --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index b5dc23bd..fc60a008 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.38' +version = '0.6.39' # The full version, including alpha/beta/rc tags. -release = '0.6.38' +release = '0.6.39' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 3ab400cd437e4839cb8d4cc70dd5889a5b0c7469 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 12 May 2013 14:13:13 -0400 Subject: Bumped to 0.6.40 in preparation for next release. --HG-- branch : distribute extra : rebase_source : 355bf27e11fdf906de100c2a47145d44fac082cc --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fc60a008..ac332deb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2011, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.39' +version = '0.6.40' # The full version, including alpha/beta/rc tags. -release = '0.6.39' +release = '0.6.40' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 17bc3630ba27ac4ce6fe4537f071e5621c31a5bc Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 13 May 2013 08:22:02 -0400 Subject: Update versions in preparation for an 0.7b1 release --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 9a60cfe1..25022b03 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.6.40' +version = '0.7b1' # The full version, including alpha/beta/rc tags. -release = '0.6.40' +release = '0.7b1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 6075a86ef9810670e9b89c9f4321aad19158fad0 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 24 May 2013 16:36:21 -0400 Subject: Bump to 0.7b2 for next release --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 25022b03..3ce8913e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7b1' +version = '0.7b2' # The full version, including alpha/beta/rc tags. -release = '0.7b1' +release = '0.7b2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 8f52bc5f9db7b202461c6d2421930545a683fb5f Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 24 May 2013 16:59:46 -0400 Subject: Bump to next anticipated version --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3ce8913e..1a896681 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7b2' +version = '0.7b3' # The full version, including alpha/beta/rc tags. -release = '0.7b2' +release = '0.7b3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 2a6828a3a6f98a6f6e0e97b02b1c6e397130a473 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 25 May 2013 16:04:05 -0400 Subject: Bump version for subsequent release --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1a896681..b702d358 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7b3' +version = '0.7b4' # The full version, including alpha/beta/rc tags. -release = '0.7b3' +release = '0.7b4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From a1bc841f097ac20ee5a6526c804398ffb3604c80 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 28 May 2013 17:16:42 -0400 Subject: Bumped to 0.7b5 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index b702d358..8cd3b069 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7b4' +version = '0.7b5' # The full version, including alpha/beta/rc tags. -release = '0.7b4' +release = '0.7b5' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 87818a14ed9897a88737f287b634191337a2ed2a Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 2 Jun 2013 10:46:47 -0400 Subject: Bumped to 0.7 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8cd3b069..f38127c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7b5' +version = '0.7' # The full version, including alpha/beta/rc tags. -release = '0.7b5' +release = '0.7' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From ccc570ac00b66b799cd8e626543340786df1bcd2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 2 Jun 2013 11:37:26 -0400 Subject: Bumped to 0.7.1 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f38127c0..61775604 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7' +version = '0.7.1' # The full version, including alpha/beta/rc tags. -release = '0.7' +release = '0.7.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 6b694814e0f877a45aff1091849ec09abd8f0ed2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 3 Jun 2013 14:20:13 -0400 Subject: Bumped to 0.7.2 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 61775604..e2815394 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7.1' +version = '0.7.2' # The full version, including alpha/beta/rc tags. -release = '0.7.1' +release = '0.7.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 91c8bc673be3727f707f58251afa6a35bb6da3d6 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 9 Jun 2013 11:01:36 -0400 Subject: Bumped to 0.7.3 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index e2815394..3861b79a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7.2' +version = '0.7.3' # The full version, including alpha/beta/rc tags. -release = '0.7.2' +release = '0.7.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 744a61f18bbfcbf7dfaa08886185b4595d8b7bcb Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Mon, 17 Jun 2013 19:23:33 +0100 Subject: Misc. updates following 2to3 checks. --HG-- branch : single-codebase --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3861b79a..44d8378a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,8 +40,8 @@ source_suffix = '.txt' master_doc = 'index' # General information about the project. -project = u'Setuptools' -copyright = u'2009-2013, The fellowship of the packaging' +project = 'Setuptools' +copyright = '2009-2013, The fellowship of the packaging' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -175,8 +175,8 @@ htmlhelp_basename = 'Setuptoolsdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'Setuptools.tex', ur'Setuptools Documentation', - ur'The fellowship of the packaging', 'manual'), + ('index', 'Setuptools.tex', 'Setuptools Documentation', + 'The fellowship of the packaging', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of -- cgit v1.2.1 From 49baf51edde145b96913aaf0151eb4dff400b3e3 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 18 Jun 2013 15:31:53 -0500 Subject: Bumped to 0.8 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3861b79a..d2e5276c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.7.3' +version = '0.8' # The full version, including alpha/beta/rc tags. -release = '0.7.3' +release = '0.8' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 70dc35dcc21fdb1918e5562d105427aeea424c28 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 5 Jul 2013 13:12:49 -0400 Subject: Bumped to 0.9 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3fccd87f..7113c365 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.8' +version = '0.9' # The full version, including alpha/beta/rc tags. -release = '0.8' +release = '0.9' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 87750d2cf138ed8f0e600e61db9a4b340f0f4b9a Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 13 Jul 2013 11:54:35 -0400 Subject: Bumped to 0.10 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 7113c365..d99639d6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.9' +version = '0.10' # The full version, including alpha/beta/rc tags. -release = '0.9' +release = '0.10' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 21ba9de1f81928b82344d3f61031cb14f1451cdc Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 13 Jul 2013 16:16:58 -0400 Subject: Bumped to 0.9.1 in preparation for next release. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d99639d6..3c71f326 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.10' +version = '0.9.1' # The full version, including alpha/beta/rc tags. -release = '0.10' +release = '0.9.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 5896424c4061b74ed9625077131df0f8e4cd2a10 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 13 Jul 2013 20:48:26 -0400 Subject: Have the documentation also grab the version from setuptools/__init__.py --- docs/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3c71f326..fbdb8b51 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,7 @@ # serve to show the default. import sys, os +import setuptools # 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 @@ -48,9 +49,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = '0.9.1' +version = setuptools.__version__ # The full version, including alpha/beta/rc tags. -release = '0.9.1' +release = setuptools.__version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 43f8c9aaff8c71c1c1e841827509c405c20ce909 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 25 Jul 2013 10:34:33 +0200 Subject: For docs, load the setuptools version from the setup script, where it's authoritative, rather than from the library, which might not be ./setuptools --- docs/conf.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fbdb8b51..661ac486 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,8 +14,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os -import setuptools +import setup # 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 @@ -49,9 +48,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = setuptools.__version__ +version = setup.setup_params['version'] # The full version, including alpha/beta/rc tags. -release = setuptools.__version__ +release = setup.setup_params['version'] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 3e53e141e0a0f03738b3943d0b0d77b1bf49883e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 5 Aug 2013 17:20:10 +0200 Subject: Sphinx allows a callable named 'setup' to be provided in the config. If present, it attempts to call it. Therefore, use another name when importing the setup module. The docs may now be built using 'setup.py build_sphinx'. --HG-- extra : rebase_source : a5f5e0d9d624f976b7a12e44adf3cc94d4f6ac44 --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 661ac486..9929aaf6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import setup +import setup as setup_script # 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 @@ -48,9 +48,9 @@ copyright = '2009-2013, The fellowship of the packaging' # built documents. # # The short X.Y version. -version = setup.setup_params['version'] +version = setup_script.setup_params['version'] # The full version, including alpha/beta/rc tags. -release = setup.setup_params['version'] +release = setup_script.setup_params['version'] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -- cgit v1.2.1 From 9ce32d32b0b4d62ba844884b436d5a57e5b921cb Mon Sep 17 00:00:00 2001 From: ericholscher Date: Sat, 2 Aug 2014 08:07:57 -0700 Subject: Fix docs to work --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 9929aaf6..4ab9f41c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,6 +13,9 @@ # # All configuration values have a default; values that are commented out # serve to show the default. +import sys, os + +sys.path.append(os.path.abspath('..')) import setup as setup_script @@ -195,3 +198,4 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True + -- cgit v1.2.1 From 702a87a0a2ab03c376fea01903075c8fed45a8fb Mon Sep 17 00:00:00 2001 From: ericholscher Date: Sat, 2 Aug 2014 15:35:33 +0000 Subject: conf.py edited online with Bitbucket --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4ab9f41c..faf3a915 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -198,4 +198,3 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True - -- cgit v1.2.1 From 9fe6b474304a5a679b00d6218f9d9471a2c8a2fd Mon Sep 17 00:00:00 2001 From: ericholscher Date: Sat, 16 Aug 2014 15:52:49 +0000 Subject: Add comment to explain code. --- docs/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index faf3a915..203dc93d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,9 +12,10 @@ # autogenerated file. # # All configuration values have a default; values that are commented out -# serve to show the default. -import sys, os +# serve to show the default +# Allow Sphinx to find the setup command that is imported below. +import sys, os sys.path.append(os.path.abspath('..')) import setup as setup_script -- cgit v1.2.1 From 5804094016f1b5188c14d1c69fdae7c55f1f242d Mon Sep 17 00:00:00 2001 From: ericholscher Date: Sun, 17 Aug 2014 05:52:57 +0000 Subject: Update conf.py to place it below original docstring. --- docs/conf.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 203dc93d..8be5c3dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,17 +14,16 @@ # All configuration values have a default; values that are commented out # serve to show the default -# Allow Sphinx to find the setup command that is imported below. +# 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. + +# Allow Sphinx to find the setup command that is imported below, as referenced above. import sys, os sys.path.append(os.path.abspath('..')) import setup as setup_script -# 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.append(os.path.abspath('.')) - # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions -- cgit v1.2.1 From caea578cd02a7cb2f7cfa453dfabff66e56aff8d Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 30 Dec 2014 11:39:07 -0500 Subject: Moved linkify logic to documentation builder as Sphinx extension. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8be5c3dd..6cb8f636 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ import setup as setup_script # 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 = ['linkify'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.1 From c7de48c1f42611b25b0ab776ece87763515cc120 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 30 Dec 2014 12:50:39 -0500 Subject: Update copyright --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6cb8f636..5ea2e05e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,7 +44,7 @@ master_doc = 'index' # General information about the project. project = 'Setuptools' -copyright = '2009-2013, The fellowship of the packaging' +copyright = '2009-2014, The fellowship of the packaging' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the -- cgit v1.2.1 From 02fac66f96af6b6952d227809186db1c5ae628a6 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 24 Feb 2015 22:36:06 -0600 Subject: Use rst.linker for generating linked changelog --- docs/conf.py | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 5ea2e05e..24830987 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ import setup as setup_script # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['linkify'] +extensions = ['rst.linker'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -198,3 +198,50 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True + +link_files = { + 'CHANGES.txt': dict( + using=dict( + BB='https://bitbucket.org', + GH='https://github.com', + ), + replace=[ + dict( + pattern=r"(Issue )?#(?P\d+)", + url='{BB}/pypa/setuptools/issue/{issue}', + ), + dict( + pattern=r"Pull Request ?#(?P\d+)", + url='{BB}/pypa/setuptools/pull-request/{pull_request}', + ), + dict( + pattern=r"Distribute #(?P\d+)", + url='{BB}/tarek/distribute/issue/{distribute}', + ), + dict( + pattern=r"Buildout #(?P\d+)", + url='{GH}/buildout/buildout/issues/{buildout}', + ), + dict( + pattern=r"Old Setuptools #(?P\d+)", + url='http://bugs.python.org/setuptools/issue{old_setuptools}', + ), + dict( + pattern=r"Jython #(?P\d+)", + url='http://bugs.jython.org/issue{jython}', + ), + dict( + pattern=r"Python #(?P\d+)", + url='http://bugs.python.org/issue{python}', + ), + dict( + pattern=r"Interop #(?P\d+)", + url='{GH}/pypa/interoperability-peps/issues/{interop}', + ), + dict( + pattern=r"Pip #(?P\d+)", + url='{GH}/pypa/pip/issues/{pip}', + ), + ], + ), +} -- cgit v1.2.1 From d8fda18abfeff18dd1b1588fbca707d1b2b14214 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 15 Apr 2015 08:58:22 -0400 Subject: Bump packaging version to 15.1 --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 24830987..ba3a35bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -242,6 +242,10 @@ link_files = { pattern=r"Pip #(?P\d+)", url='{GH}/pypa/pip/issues/{pip}', ), + dict( + pattern=r"Packaging #(?P\d+)", + url='{GH}/pypa/packaging/issues/{packaging}', + ), ], ), } -- cgit v1.2.1 From 2271e6d1d51c694a73a541b497fb26cc506516d5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 19 Aug 2015 17:43:21 +0100 Subject: Link packaging versions to CHANGELOG in packaging project. Fixes #416. --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ba3a35bc..c2a63873 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -246,6 +246,10 @@ link_files = { pattern=r"Packaging #(?P\d+)", url='{GH}/pypa/packaging/issues/{packaging}', ), + dict( + pattern=r"[Pp]ackaging (?P\d+(\.\d+)+)", + url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', + ), ], ), } -- cgit v1.2.1 From be18a01654d05ebfba04e713c20c1fbd4d170dc3 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 19 Feb 2016 11:10:17 -0500 Subject: Add hyperlinks to PEPs in changelog. --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c2a63873..155f83f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -250,6 +250,10 @@ link_files = { pattern=r"[Pp]ackaging (?P\d+(\.\d+)+)", url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', ), + dict( + pattern=r"PEP[- ](?P\d+)", + url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', + ), ], ), } -- cgit v1.2.1 From 1b31a684e7198b9f46faaeddcae0cb94a0e43e84 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 19 Feb 2016 11:12:13 -0500 Subject: Add timestamps to changelog. --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 155f83f3..1a4da380 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -254,6 +254,10 @@ link_files = { pattern=r"PEP[- ](?P\d+)", url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), + dict( + pattern=r"^(?m)((?P\d+(\.\d+){1,2}))\n[-=]+\n", + with_scm="{text}\n{rev[timestamp]}\n", + ), ], ), } -- cgit v1.2.1 From 3b90be7bb6323eb44d0f28864509c1d47aa098de Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 29 Mar 2016 12:17:06 -0400 Subject: Update most bitbucket references to point to Github now. Fixes #422. --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1a4da380..6570f661 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -208,11 +208,11 @@ link_files = { replace=[ dict( pattern=r"(Issue )?#(?P\d+)", - url='{BB}/pypa/setuptools/issue/{issue}', + url='{GH}/pypa/setuptools/issues/{issue}', ), dict( - pattern=r"Pull Request ?#(?P\d+)", - url='{BB}/pypa/setuptools/pull-request/{pull_request}', + pattern=r"BB Pull Request ?#(?P\d+)", + url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', ), dict( pattern=r"Distribute #(?P\d+)", -- cgit v1.2.1 From dd0c78d26b7510481bc4587c9bb5a6fbfd2b5c8d Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 29 Mar 2016 13:13:18 -0400 Subject: Just render the date and not the time of tagged releases in the changelog. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6570f661..1bf9c334 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -256,7 +256,7 @@ link_files = { ), dict( pattern=r"^(?m)((?P\d+(\.\d+){1,2}))\n[-=]+\n", - with_scm="{text}\n{rev[timestamp]}\n", + with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", ), ], ), -- cgit v1.2.1 From fd4f10290ea64f72a139fe23b811b40bc1f48f17 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 29 Mar 2016 16:32:01 -0400 Subject: Recognize semver versions with v prefix in rst.linker config --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1bf9c334..6877c5c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -255,7 +255,7 @@ link_files = { url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), dict( - pattern=r"^(?m)((?P\d+(\.\d+){1,2}))\n[-=]+\n", + pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", ), ], -- cgit v1.2.1 From c5189c3992f32dcabf5cb294340bf4cad294de23 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 1 Apr 2016 17:01:51 -0400 Subject: Rename CHANGES and README files for nicer rendering on Github. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6877c5c0..f315e2b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,7 +200,7 @@ latex_documents = [ #latex_use_modindex = True link_files = { - 'CHANGES.txt': dict( + 'CHANGES.rst': dict( using=dict( BB='https://bitbucket.org', GH='https://github.com', -- cgit v1.2.1 From 0d3a896695ae028eca50330490f6ea2811450e0e Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 2 May 2016 10:18:57 -0400 Subject: Convert tabs to spaces. Fixes #489. --- docs/conf.py | 120 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 60 insertions(+), 60 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f315e2b7..604e7138 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,64 +200,64 @@ latex_documents = [ #latex_use_modindex = True link_files = { - 'CHANGES.rst': dict( - using=dict( - BB='https://bitbucket.org', - GH='https://github.com', - ), - replace=[ - dict( - pattern=r"(Issue )?#(?P\d+)", - url='{GH}/pypa/setuptools/issues/{issue}', - ), - dict( - pattern=r"BB Pull Request ?#(?P\d+)", - url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', - ), - dict( - pattern=r"Distribute #(?P\d+)", - url='{BB}/tarek/distribute/issue/{distribute}', - ), - dict( - pattern=r"Buildout #(?P\d+)", - url='{GH}/buildout/buildout/issues/{buildout}', - ), - dict( - pattern=r"Old Setuptools #(?P\d+)", - url='http://bugs.python.org/setuptools/issue{old_setuptools}', - ), - dict( - pattern=r"Jython #(?P\d+)", - url='http://bugs.jython.org/issue{jython}', - ), - dict( - pattern=r"Python #(?P\d+)", - url='http://bugs.python.org/issue{python}', - ), - dict( - pattern=r"Interop #(?P\d+)", - url='{GH}/pypa/interoperability-peps/issues/{interop}', - ), - dict( - pattern=r"Pip #(?P\d+)", - url='{GH}/pypa/pip/issues/{pip}', - ), - dict( - pattern=r"Packaging #(?P\d+)", - url='{GH}/pypa/packaging/issues/{packaging}', - ), - dict( - pattern=r"[Pp]ackaging (?P\d+(\.\d+)+)", - url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', - ), - dict( - pattern=r"PEP[- ](?P\d+)", - url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', - ), - dict( - pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", - with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", - ), - ], - ), + 'CHANGES.rst': dict( + using=dict( + BB='https://bitbucket.org', + GH='https://github.com', + ), + replace=[ + dict( + pattern=r"(Issue )?#(?P\d+)", + url='{GH}/pypa/setuptools/issues/{issue}', + ), + dict( + pattern=r"BB Pull Request ?#(?P\d+)", + url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', + ), + dict( + pattern=r"Distribute #(?P\d+)", + url='{BB}/tarek/distribute/issue/{distribute}', + ), + dict( + pattern=r"Buildout #(?P\d+)", + url='{GH}/buildout/buildout/issues/{buildout}', + ), + dict( + pattern=r"Old Setuptools #(?P\d+)", + url='http://bugs.python.org/setuptools/issue{old_setuptools}', + ), + dict( + pattern=r"Jython #(?P\d+)", + url='http://bugs.jython.org/issue{jython}', + ), + dict( + pattern=r"Python #(?P\d+)", + url='http://bugs.python.org/issue{python}', + ), + dict( + pattern=r"Interop #(?P\d+)", + url='{GH}/pypa/interoperability-peps/issues/{interop}', + ), + dict( + pattern=r"Pip #(?P\d+)", + url='{GH}/pypa/pip/issues/{pip}', + ), + dict( + pattern=r"Packaging #(?P\d+)", + url='{GH}/pypa/packaging/issues/{packaging}', + ), + dict( + pattern=r"[Pp]ackaging (?P\d+(\.\d+)+)", + url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', + ), + dict( + pattern=r"PEP[- ](?P\d+)", + url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', + ), + dict( + pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", + with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", + ), + ], + ), } -- cgit v1.2.1 From 8fea56035d22fc46e8237fa8f6b1b548fd0105d5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 3 Jun 2016 14:15:57 -0400 Subject: Patch changelog relative to 'docs' now that docs are built in RTD --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 604e7138..07d6ad41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -200,7 +200,7 @@ latex_documents = [ #latex_use_modindex = True link_files = { - 'CHANGES.rst': dict( + '../CHANGES.rst': dict( using=dict( BB='https://bitbucket.org', GH='https://github.com', -- cgit v1.2.1 From 86689c912fe8d7c0c468e177f0f1f8b9260d4924 Mon Sep 17 00:00:00 2001 From: stepshal Date: Sun, 24 Jul 2016 17:59:53 +0700 Subject: docs/conf.py: split multiple imports on one line. --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 07d6ad41..be010152 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,8 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # Allow Sphinx to find the setup command that is imported below, as referenced above. -import sys, os +import os +import sys sys.path.append(os.path.abspath('..')) import setup as setup_script -- cgit v1.2.1 From cfaab99763f94c1e73f8bc4c1a61648b70ecae72 Mon Sep 17 00:00:00 2001 From: stepshal Date: Mon, 25 Jul 2016 01:24:33 +0700 Subject: docs/conf.py: remove unused boilerplate. --- docs/conf.py | 97 ------------------------------------------------------------ 1 file changed, 97 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index be010152..dc0d8fae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,9 +37,6 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.txt' -# The encoding of source files. -#source_encoding = 'utf-8' - # The master toctree document. master_doc = 'index' @@ -56,43 +53,13 @@ version = setup_script.setup_params['version'] # The full version, including alpha/beta/rc tags. release = setup_script.setup_params['version'] -# 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 documents that shouldn't be included in the build. -#unused_docs = [] - # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] -# 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 --------------------------------------------------- @@ -100,11 +67,6 @@ pygments_style = 'sphinx' # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'nature' -# 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 = ['_theme'] @@ -115,24 +77,6 @@ html_title = "Setuptools documentation" # A shorter title for the navigation bar. Default is the same as html_title. html_short_title = "Setuptools" -# 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 @@ -140,42 +84,18 @@ html_use_smartypants = True # Custom sidebar templates, maps document names to template names. html_sidebars = {'index': 'indexsidebar.html'} -# 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_use_modindex = False # If false, no index is generated. html_use_index = False -# 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, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - # Output file base name for HTML help builder. htmlhelp_basename = 'Setuptoolsdoc' # -- Options for LaTeX output -------------------------------------------------- -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ @@ -183,23 +103,6 @@ latex_documents = [ 'The fellowship of the packaging', '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 - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_use_modindex = True - link_files = { '../CHANGES.rst': dict( using=dict( -- cgit v1.2.1 From 31bd37c6ac8de9e8c1bacebc2d8e1215df91eb96 Mon Sep 17 00:00:00 2001 From: stepshal Date: Tue, 18 Oct 2016 20:24:35 +0700 Subject: Fix quantity of blank lines. --- docs/conf.py | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index dc0d8fae..fae8e632 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,6 @@ exclude_trees = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' - # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with @@ -93,7 +92,6 @@ html_use_index = False # Output file base name for HTML help builder. htmlhelp_basename = 'Setuptoolsdoc' - # -- Options for LaTeX output -------------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples -- cgit v1.2.1 From 249f870f2c6fb60734e9db34e44f7e44cd35c914 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 1 Jan 2017 10:08:00 -0500 Subject: Drop support for 'tag_svn_version' distribution option. Fixes #619. --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fae8e632..c1854ed8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -156,6 +156,10 @@ link_files = { pattern=r"PEP[- ](?P\d+)", url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), + dict( + pattern=r"setuptools_svn #(?P\d+)", + url='{GH}/jaraco/setuptools_svn/issues/{setuptools_svn}', + ), dict( pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", -- cgit v1.2.1 From e83845ac9b23d3e6e397263aa933372148fc5fee Mon Sep 17 00:00:00 2001 From: smheidrich Date: Thu, 2 Feb 2017 12:32:27 +0100 Subject: Added autosectionlabel Sphinx extension and replaced some obsolete links. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c1854ed8..fe684271 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ import setup as setup_script # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['rst.linker'] +extensions = ['rst.linker', 'sphinx.ext.autosectionlabel'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.1 From 943833d493a95061c4c432337e7133aa311ccdba Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 21:32:37 -0400 Subject: Update docs to use jaraco.packaging.sphinx to grab metadata from the package. --- docs/conf.py | 64 ++++++++++++++++-------------------------------------------- 1 file changed, 17 insertions(+), 47 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fe684271..1b1bb5fb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,18 +18,11 @@ # 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. -# Allow Sphinx to find the setup command that is imported below, as referenced above. -import os -import sys -sys.path.append(os.path.abspath('..')) - -import setup as setup_script - # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['rst.linker', 'sphinx.ext.autosectionlabel'] +extensions = ['rst.linker', 'sphinx.ext.autosectionlabel', 'jaraco.packaging.sphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -40,19 +33,6 @@ source_suffix = '.txt' # The master toctree document. master_doc = 'index' -# General information about the project. -project = 'Setuptools' -copyright = '2009-2014, The fellowship of the packaging' - -# 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 = setup_script.setup_params['version'] -# The full version, including alpha/beta/rc tags. -release = setup_script.setup_params['version'] - # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] @@ -69,13 +49,6 @@ html_theme = 'nature' # Add any paths that contain custom themes here, relative to this directory. html_theme_path = ['_theme'] -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -html_title = "Setuptools documentation" - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = "Setuptools" - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants = True @@ -89,9 +62,6 @@ html_use_modindex = False # If false, no index is generated. html_use_index = False -# Output file base name for HTML help builder. -htmlhelp_basename = 'Setuptoolsdoc' - # -- Options for LaTeX output -------------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples @@ -109,60 +79,60 @@ link_files = { ), replace=[ dict( - pattern=r"(Issue )?#(?P\d+)", - url='{GH}/pypa/setuptools/issues/{issue}', + pattern=r'(Issue )?#(?P\d+)', + url='{package_url}/issues/{issue}', ), dict( - pattern=r"BB Pull Request ?#(?P\d+)", + pattern=r'BB Pull Request ?#(?P\d+)', url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}', ), dict( - pattern=r"Distribute #(?P\d+)", + pattern=r'Distribute #(?P\d+)', url='{BB}/tarek/distribute/issue/{distribute}', ), dict( - pattern=r"Buildout #(?P\d+)", + pattern=r'Buildout #(?P\d+)', url='{GH}/buildout/buildout/issues/{buildout}', ), dict( - pattern=r"Old Setuptools #(?P\d+)", + pattern=r'Old Setuptools #(?P\d+)', url='http://bugs.python.org/setuptools/issue{old_setuptools}', ), dict( - pattern=r"Jython #(?P\d+)", + pattern=r'Jython #(?P\d+)', url='http://bugs.jython.org/issue{jython}', ), dict( - pattern=r"Python #(?P\d+)", + pattern=r'Python #(?P\d+)', url='http://bugs.python.org/issue{python}', ), dict( - pattern=r"Interop #(?P\d+)", + pattern=r'Interop #(?P\d+)', url='{GH}/pypa/interoperability-peps/issues/{interop}', ), dict( - pattern=r"Pip #(?P\d+)", + pattern=r'Pip #(?P\d+)', url='{GH}/pypa/pip/issues/{pip}', ), dict( - pattern=r"Packaging #(?P\d+)", + pattern=r'Packaging #(?P\d+)', url='{GH}/pypa/packaging/issues/{packaging}', ), dict( - pattern=r"[Pp]ackaging (?P\d+(\.\d+)+)", + pattern=r'[Pp]ackaging (?P\d+(\.\d+)+)', url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst', ), dict( - pattern=r"PEP[- ](?P\d+)", + pattern=r'PEP[- ](?P\d+)', url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', ), dict( - pattern=r"setuptools_svn #(?P\d+)", + pattern=r'setuptools_svn #(?P\d+)', url='{GH}/jaraco/setuptools_svn/issues/{setuptools_svn}', ), dict( - pattern=r"^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n", - with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n", + pattern=r'^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n', + with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n', ), ], ), -- cgit v1.2.1 From 52c58bedd49552359993b533fcd86da4ff58b0c2 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 22:06:23 -0400 Subject: Add hack to invoke bootstrap script so that setup.py --version can be invoked. --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1b1bb5fb..36d3f24c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,6 +18,11 @@ # 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. + +# hack to run the bootstrap script so that jaraco.packaging.sphinx +# can invoke setup.py +exec(open('../bootstrap.py').read()) + # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions -- cgit v1.2.1 From c9587fe384a2eab6e9d81408abb58936d15286ed Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 22:18:49 -0400 Subject: Try running bootstrap in subprocess in order to be in the project root. --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 36d3f24c..6119ad12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,9 @@ # hack to run the bootstrap script so that jaraco.packaging.sphinx # can invoke setup.py +import subprocess +import sys +subprocess.Popen([sys.executable, 'bootstrap.py'], cwd='..') exec(open('../bootstrap.py').read()) # -- General configuration ----------------------------------------------------- -- cgit v1.2.1 From 74329a7fa2a482309e4eb244b3920e28a76cfcbf Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 22:23:04 -0400 Subject: Remove excess hack --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 6119ad12..15061ecf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,6 @@ import subprocess import sys subprocess.Popen([sys.executable, 'bootstrap.py'], cwd='..') -exec(open('../bootstrap.py').read()) # -- General configuration ----------------------------------------------------- -- cgit v1.2.1 From b10187e1fa7f602d7f5cc75821d14b494625aef9 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 30 Mar 2017 22:38:03 -0400 Subject: Make sure bootstrap finishes before continuing, and ensure that jaraco.packaging.sphinx is run before rst.linker. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 15061ecf..7f781fef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,13 +23,13 @@ # can invoke setup.py import subprocess import sys -subprocess.Popen([sys.executable, 'bootstrap.py'], cwd='..') +subprocess.check_call([sys.executable, 'bootstrap.py'], cwd='..') # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['rst.linker', 'sphinx.ext.autosectionlabel', 'jaraco.packaging.sphinx'] +extensions = ['jaraco.packaging.sphinx', 'rst.linker', 'sphinx.ext.autosectionlabel'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.1 From 332b586b7c65dee7e9a2dbbcbc1c896f4a862a3f Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 31 Mar 2017 08:22:38 -0400 Subject: Hack must genuflect to the arbitrory invocation location --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 7f781fef..28f86da4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,9 @@ # can invoke setup.py import subprocess import sys -subprocess.check_call([sys.executable, 'bootstrap.py'], cwd='..') +import os +proj_root = os.path.join(os.path.dirname(__file__), os.path.pardir) +subprocess.check_call([sys.executable, 'bootstrap.py'], cwd=proj_root) # -- General configuration ----------------------------------------------------- -- cgit v1.2.1 From e8ca95c2e12f46e203715194e4729f8b33de2c23 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 31 Mar 2017 08:27:33 -0400 Subject: Constrain hack to the RTD environment. Rely on bootstrap routine to make dependencies available. --- docs/conf.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 28f86da4..f7d02303 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,14 +18,17 @@ # 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. - -# hack to run the bootstrap script so that jaraco.packaging.sphinx -# can invoke setup.py import subprocess import sys import os -proj_root = os.path.join(os.path.dirname(__file__), os.path.pardir) -subprocess.check_call([sys.executable, 'bootstrap.py'], cwd=proj_root) + + +# hack to run the bootstrap script so that jaraco.packaging.sphinx +# can invoke setup.py +'READTHEDOCS' in os.environ and subprocess.check_call( + [sys.executable, 'bootstrap.py'], + cwd=os.path.join(os.path.dirname(__file__), os.path.pardir), +) # -- General configuration ----------------------------------------------------- -- cgit v1.2.1 From 2f2f21ad470a93dff15db81f450d02a238d87424 Mon Sep 17 00:00:00 2001 From: Jeremy Bowman Date: Mon, 14 May 2018 14:48:39 -0400 Subject: Fix doc build warnings --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f7d02303..c7eb6d3f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,7 +34,7 @@ import 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 = ['jaraco.packaging.sphinx', 'rst.linker', 'sphinx.ext.autosectionlabel'] +extensions = ['jaraco.packaging.sphinx', 'rst.linker'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -45,6 +45,9 @@ source_suffix = '.txt' # The master toctree document. master_doc = 'index' +# A list of glob-style patterns that should be excluded when looking for source files. +exclude_patterns = ['requirements.txt'] + # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] -- cgit v1.2.1 From f3ff0541b6967ee91be3f572c5afe4f559436aa1 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 26 Jan 2019 12:12:55 -0500 Subject: Add Tidelift template --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/conf.py (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..d0287332 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,4 @@ + +# Custom sidebar templates, maps document names to template names. +templates_path = ['_templates'] +html_sidebars = {'index': 'tidelift-sidebar.html'} -- cgit v1.2.1 From c6655951aa8292127f01d53c337da1da642efe74 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 26 Jan 2019 13:18:15 -0500 Subject: Rely on alabaster theme to support sidebar rendering. --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d0287332..3d109305 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,5 @@ # Custom sidebar templates, maps document names to template names. +html_theme = 'alabaster' templates_path = ['_templates'] html_sidebars = {'index': 'tidelift-sidebar.html'} -- cgit v1.2.1 From 05f42a2c14275937250c99478c94b20171d14aeb Mon Sep 17 00:00:00 2001 From: A_Rog Date: Wed, 14 Aug 2019 00:40:12 +0100 Subject: Fixed html sidebars to supported version in Sphinx (#1804) --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c7eb6d3f..cbd19fb4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,7 +69,7 @@ html_theme_path = ['_theme'] html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = {'index': 'indexsidebar.html'} +html_sidebars = {'index': ['relations.html', 'sourcelink.html', 'indexsidebar.html', 'searchbox.html']} # If false, no module index is generated. html_use_modindex = False -- cgit v1.2.1 From 1c187ad0cf50fbc14626f63cb669a9ec5949012f Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Mon, 9 Sep 2019 17:45:58 +0100 Subject: List sidebars to avoid errors looking for template 't' --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 3d109305..dbf962dd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,4 +2,4 @@ # Custom sidebar templates, maps document names to template names. html_theme = 'alabaster' templates_path = ['_templates'] -html_sidebars = {'index': 'tidelift-sidebar.html'} +html_sidebars = {'index': ['tidelift-sidebar.html']} -- cgit v1.2.1 From 94f88bf48af78c4f961fe42241da556837efa3c1 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 19 Jan 2020 11:54:02 -0500 Subject: Bootstrap the environment in tox, allowing simple 'tox' to run tests and simplifying all of the pipelines. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index cbd19fb4..6f6ae13a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ import os # hack to run the bootstrap script so that jaraco.packaging.sphinx # can invoke setup.py 'READTHEDOCS' in os.environ and subprocess.check_call( - [sys.executable, 'bootstrap.py'], + [sys.executable, '-m', 'bootstrap'], cwd=os.path.join(os.path.dirname(__file__), os.path.pardir), ) -- cgit v1.2.1 From 3d4d8b9dde61b87271861b8c7ebeb168ac4fa72b Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 19 Jan 2020 12:46:30 -0500 Subject: =?UTF-8?q?=F0=9F=91=B9=20Feed=20the=20hobgoblins=20(delint).?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conf.py | 39 +++++++++++---------------------------- 1 file changed, 11 insertions(+), 28 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index cbd19fb4..7cc61bf7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,23 +1,3 @@ -# -*- coding: utf-8 -*- -# -# Setuptools documentation build configuration file, created by -# sphinx-quickstart on Fri Jul 17 14:22:37 2009. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed automatically). -# -# 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 - -# 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. - import subprocess import sys import os @@ -30,10 +10,8 @@ import os cwd=os.path.join(os.path.dirname(__file__), os.path.pardir), ) -# -- General configuration ----------------------------------------------------- +# -- General configuration -- -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['jaraco.packaging.sphinx', 'rst.linker'] # Add any paths that contain templates here, relative to this directory. @@ -45,7 +23,8 @@ source_suffix = '.txt' # The master toctree document. master_doc = 'index' -# A list of glob-style patterns that should be excluded when looking for source files. +# A list of glob-style patterns that should be excluded +# when looking for source files. exclude_patterns = ['requirements.txt'] # List of directories, relative to source directory, that shouldn't be searched @@ -55,7 +34,7 @@ exclude_trees = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output -- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. @@ -69,7 +48,10 @@ html_theme_path = ['_theme'] html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = {'index': ['relations.html', 'sourcelink.html', 'indexsidebar.html', 'searchbox.html']} +html_sidebars = { + 'index': [ + 'relations.html', 'sourcelink.html', 'indexsidebar.html', + 'searchbox.html']} # If false, no module index is generated. html_use_modindex = False @@ -77,10 +59,11 @@ html_use_modindex = False # If false, no index is generated. html_use_index = False -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output -- # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# (source start file, target name, title, author, +# documentclass [howto/manual]). latex_documents = [ ('index', 'Setuptools.tex', 'Setuptools Documentation', 'The fellowship of the packaging', 'manual'), -- cgit v1.2.1 From 5ce9e5f343ca14f9875106f37f16ad498b294183 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 19 Jan 2020 13:25:45 -0500 Subject: =?UTF-8?q?=F0=9F=91=B9=20Feed=20the=20hobgoblins=20(delint).?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 7cc61bf7..918ca034 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,10 +64,10 @@ html_use_index = False # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, # documentclass [howto/manual]). -latex_documents = [ - ('index', 'Setuptools.tex', 'Setuptools Documentation', - 'The fellowship of the packaging', 'manual'), -] +latex_documents = [( + 'index', 'Setuptools.tex', 'Setuptools Documentation', + 'The fellowship of the packaging', 'manual', +)] link_files = { '../CHANGES.rst': dict( -- cgit v1.2.1 From 608988196d608f913398fc8853cfb797d2a1b63d Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 1 Sep 2020 19:14:22 -0400 Subject: Support 'bpo-' prefix on Python bugs --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index b92b50cc..20800e71 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,7 +101,7 @@ link_files = { url='http://bugs.jython.org/issue{jython}', ), dict( - pattern=r'Python #(?P\d+)', + pattern=r'(Python #|bpo-)(?P\d+)', url='http://bugs.python.org/issue{python}', ), dict( -- cgit v1.2.1 From d2e529896bcde20559da3fa2c01e825d218fdb18 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 1 Sep 2020 21:46:51 -0400 Subject: Add links for distutils --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 20800e71..12520586 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -128,6 +128,10 @@ link_files = { pattern=r'setuptools_svn #(?P\d+)', url='{GH}/jaraco/setuptools_svn/issues/{setuptools_svn}', ), + dict( + pattern=r'pypa/distutils#(?P\d+)', + url='{GH}/pypa/distutils/issues/{distutils}', + ), dict( pattern=r'^(?m)((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n', with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n', -- cgit v1.2.1 From 73e379cc55ac1e9ec63c4ac30b75ecc82418f513 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 23 Sep 2020 20:29:14 -0400 Subject: Use canonical extension for docs. --- docs/conf.py | 7 ------- 1 file changed, 7 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 12520586..673b6ba5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,16 +17,9 @@ extensions = ['jaraco.packaging.sphinx', 'rst.linker'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix of source filenames. -source_suffix = '.txt' - # The master toctree document. master_doc = 'index' -# A list of glob-style patterns that should be excluded -# when looking for source files. -exclude_patterns = ['requirements.txt'] - # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = [] -- cgit v1.2.1 From 455b3d3c3145254228ce31d73d8964d13550527c Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Sun, 20 Sep 2020 19:38:33 +0200 Subject: Add a :user: role in Sphinx This change adds a role that links to the GitHub user Sponsors page. If that page is not set up, it'll redirect to the GitHub user profile page instead: Links to https://github.com/sponsors/{{ username }} open as GitHub Sponsors page if the target `username` has it enabled and redirect to https://github.com/{{ username }} if it's disabled. --- docs/conf.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 673b6ba5..d5111391 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,18 @@ import os cwd=os.path.join(os.path.dirname(__file__), os.path.pardir), ) +# -- Project information ----------------------------------------------------- + +github_url = 'https://github.com' +github_sponsors_url = f'{github_url}/sponsors' + # -- General configuration -- -extensions = ['jaraco.packaging.sphinx', 'rst.linker'] +extensions = [ + 'sphinx.ext.extlinks', # allows to create custom roles easily + 'jaraco.packaging.sphinx', + 'rst.linker', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -27,6 +36,11 @@ exclude_trees = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# -- Options for extlinks extension --------------------------------------- +extlinks = { + 'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323 +} + # -- Options for HTML output -- # The theme to use for HTML and HTML Help pages. Major themes that come with -- cgit v1.2.1 From b170eac3e00f65c3d56d48d5aa8ee18f00a7baf9 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Fri, 16 Oct 2020 01:09:14 +0200 Subject: =?UTF-8?q?=F0=9F=9A=91=20Make=20Sphinx=20nitpicky=20about=20broke?= =?UTF-8?q?n=20references?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #2424 --- docs/conf.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index d5111391..1928af58 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -146,3 +146,7 @@ link_files = { ], ), } + + +# Be strict about any broken references: +nitpicky = True -- cgit v1.2.1 From 883f33613572e3c92021b58522b54958b00cdc87 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Fri, 16 Oct 2020 01:13:03 +0200 Subject: =?UTF-8?q?=E2=9C=A8Make=20the=20default=20implicit=20role=20autof?= =?UTF-8?q?ind=20targets?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 1928af58..982f5e62 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -150,3 +150,8 @@ link_files = { # Be strict about any broken references: nitpicky = True + + +# Ref: https://github.com/python-attrs/attrs/pull/571/files\ +# #diff-85987f48f1258d9ee486e3191495582dR82 +default_role = 'any' -- cgit v1.2.1 From 68b6847767c5f6914efd1891df957f7db0efdc1e Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Mon, 19 Oct 2020 00:34:58 +0200 Subject: Enable intersphinx to link against CPython docs --- docs/conf.py | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 982f5e62..a0449699 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,7 @@ github_sponsors_url = f'{github_url}/sponsors' extensions = [ 'sphinx.ext.extlinks', # allows to create custom roles easily + 'sphinx.ext.intersphinx', # allows interlinking external docs sites 'jaraco.packaging.sphinx', 'rst.linker', ] @@ -155,3 +156,10 @@ nitpicky = True # Ref: https://github.com/python-attrs/attrs/pull/571/files\ # #diff-85987f48f1258d9ee486e3191495582dR82 default_role = 'any' + + +# Allow linking objects on other Sphinx sites seamlessly: +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), + 'python2': ('https://docs.python.org/2', None), +} -- cgit v1.2.1 From 18b7a3e77aa81e9d22cd0a52061a2c8e3a640cc8 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Mon, 19 Oct 2020 00:36:03 +0200 Subject: Allow some refs to undocumented/undeclared objects --- docs/conf.py | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index a0449699..de9fe3f8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -152,6 +152,42 @@ link_files = { # Be strict about any broken references: nitpicky = True +# Ref: https://stackoverflow.com/a/30624034/595220 +nitpick_ignore = [ + ('c:func', 'SHGetSpecialFolderPath'), # ref to MS docs + ('envvar', 'DISTUTILS_DEBUG'), # undocumented + ('envvar', 'HOME'), # undocumented + ('envvar', 'PLAT'), # undocumented + ('py:attr', 'CCompiler.language_map'), # undocumented + ('py:attr', 'CCompiler.language_order'), # undocumented + ('py:class', 'distutils.dist.Distribution'), # undocumented + ('py:class', 'distutils.extension.Extension'), # undocumented + ('py:class', 'BorlandCCompiler'), # undocumented + ('py:class', 'CCompiler'), # undocumented + ('py:class', 'CygwinCCompiler'), # undocumented + ('py:class', 'distutils.dist.DistributionMetadata'), # undocumented + ('py:class', 'FileList'), # undocumented + ('py:class', 'IShellLink'), # ref to MS docs + ('py:class', 'MSVCCompiler'), # undocumented + ('py:class', 'OptionDummy'), # undocumented + ('py:class', 'UnixCCompiler'), # undocumented + ('py:exc', 'CompileError'), # undocumented + ('py:exc', 'DistutilsExecError'), # undocumented + ('py:exc', 'DistutilsFileError'), # undocumented + ('py:exc', 'LibError'), # undocumented + ('py:exc', 'LinkError'), # undocumented + ('py:exc', 'PreprocessError'), # undocumented + ('py:func', 'distutils.CCompiler.new_compiler'), # undocumented + # undocumented: + ('py:func', 'distutils.dist.DistributionMetadata.read_pkg_file'), + ('py:func', 'distutils.file_util._copy_file_contents'), # undocumented + ('py:func', 'distutils.log.debug'), # undocumented + ('py:func', 'distutils.spawn.find_executable'), # undocumented + ('py:func', 'distutils.spawn.spawn'), # undocumented + # TODO: check https://docutils.rtfd.io in the future + ('py:mod', 'docutils'), # there's no Sphinx site documenting this +] + # Ref: https://github.com/python-attrs/attrs/pull/571/files\ # #diff-85987f48f1258d9ee486e3191495582dR82 -- cgit v1.2.1 From c681f6748acaea1bf0b706528c36327cc94a6eed Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 8 Dec 2020 16:29:09 -0500 Subject: Collapse skeleton history from archive/2020-12 --- docs/conf.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/conf.py (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..433d185d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] + +master_doc = "index" + +link_files = { + '../CHANGES.rst': dict( + using=dict(GH='https://github.com'), + replace=[ + dict( + pattern=r'(Issue #|\B#)(?P\d+)', + url='{package_url}/issues/{issue}', + ), + dict( + pattern=r'(?m:^((?Pv?\d+(\.\d+){1,2}))\n[-=]+\n)', + with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n', + ), + dict( + pattern=r'PEP[- ](?P\d+)', + url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/', + ), + ], + ) +} -- cgit v1.2.1 From 7ccf254a9ac713783d2aad376cdc0990cc50bc70 Mon Sep 17 00:00:00 2001 From: Pradyun Gedam Date: Mon, 28 Dec 2020 17:49:01 +0000 Subject: Change documentation theme to Furo --- docs/conf.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8cb959df..131c7bf3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -105,7 +105,5 @@ nitpicky = True # #diff-85987f48f1258d9ee486e3191495582dR82 default_role = 'any' -# Custom sidebar templates, maps document names to template names. -html_theme = 'alabaster' -templates_path = ['_templates'] -html_sidebars = {'index': ['tidelift-sidebar.html']} +# HTML theme +html_theme = 'furo' -- cgit v1.2.1 From 71815558fb8cd44028d838b693f2083a3e969c74 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 19 Jan 2021 21:09:54 -0500 Subject: Remove bootstrap from docs build --- docs/conf.py | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8cb959df..18cd7bdc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,3 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -import subprocess -import sys -import os - - extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -82,14 +74,6 @@ link_files = { } -# hack to run the bootstrap script so that jaraco.packaging.sphinx -# can invoke setup.py -'READTHEDOCS' in os.environ and subprocess.check_call( - [sys.executable, '-m', 'bootstrap'], - cwd=os.path.join(os.path.dirname(__file__), os.path.pardir), -) - - # Add support for linking usernames github_url = 'https://github.com' github_sponsors_url = f'{github_url}/sponsors' -- cgit v1.2.1 From e70c2afc1868a7d9bb2e2887ebf19f6c84dcf283 Mon Sep 17 00:00:00 2001 From: Andrey Bienkowski Date: Tue, 9 Feb 2021 09:20:47 +0300 Subject: quickstart: recommend PyPA build instead of pep517.build see https://github.com/pypa/pep517/issues/91 --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 18cd7bdc..0a5136b0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -73,6 +73,9 @@ link_files = { ), } +intersphinx_mapping = { + 'pypa-build': ('https://pypa-build.readthedocs.io/en/latest/', None) +} # Add support for linking usernames github_url = 'https://github.com' @@ -80,7 +83,7 @@ github_sponsors_url = f'{github_url}/sponsors' extlinks = { 'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323 } -extensions += ['sphinx.ext.extlinks'] +extensions += ['sphinx.ext.extlinks', 'sphinx.ext.intersphinx'] # Be strict about any broken references: nitpicky = True -- cgit v1.2.1 From 666f44463ce9749f1040694f9954cd93a4b80bdc Mon Sep 17 00:00:00 2001 From: Amy Date: Sun, 28 Feb 2021 22:29:48 -0500 Subject: Add sphinx-inline-tabs extension --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 18cd7bdc..9082fb1d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,4 @@ -extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] +extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker', 'sphinx_inline_tabs'] master_doc = "index" -- cgit v1.2.1 From 265fb0eda039711e749bec09b512b91e9ce56627 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 5 Mar 2021 11:12:28 -0500 Subject: Extend extensions later in the file. Fixes flake8 failure and isolates the (sole) change from other concerns. --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 9082fb1d..581d8d5e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,4 @@ -extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker', 'sphinx_inline_tabs'] +extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -93,3 +93,6 @@ default_role = 'any' html_theme = 'alabaster' templates_path = ['_templates'] html_sidebars = {'index': ['tidelift-sidebar.html']} + +# Add support for inline tabs +extensions += ['sphinx_inline_tabs'] -- cgit v1.2.1 From 8698127dbd17b47d1d07e35bee3725fecb69670b Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Mon, 26 Apr 2021 04:10:20 +0200 Subject: Make sphinx fail on any warnings (#36) This change adds `nitpicky=True` (which is an equivalent of `-n`) to make Sphinx emit warnings for any references to non-existing targets. Then, it adds `-W` to make it fail whenever a single warning is seen. Finally, `--keep-going` allows Sphinx to print out all the warnings before exiting instead of showing just one and bailing. Resolves #29 Refs: * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-n * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 433d185d..f65d1faa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,3 +24,6 @@ link_files = { ], ) } + +# Be strict about any broken references: +nitpicky = True -- cgit v1.2.1 From 56b4383af214a856e93c08379c7040006bb9e1e5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 4 May 2021 15:30:01 -0400 Subject: Fix doc builds for intersphinx mapping. Supersedes #2659. --- docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 2f0d3cb3..7c748056 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -139,7 +139,7 @@ nitpick_ignore = [ ] # Allow linking objects on other Sphinx sites seamlessly: -intersphinx_mapping = { - 'python': ('https://docs.python.org/3', None), - 'python2': ('https://docs.python.org/2', None), -} +intersphinx_mapping.update( + python=('https://docs.python.org/3', None), + python2=('https://docs.python.org/2', None), +) -- cgit v1.2.1 From 5bb42992e2f5cd0d6510056da3576821fc823d2b Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Wed, 21 Apr 2021 18:29:59 +0200 Subject: Display changelog for unreleased version in docs --- docs/conf.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 93b19b57..8f3301b1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,6 @@ +from pathlib import Path + + extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -143,3 +146,16 @@ intersphinx_mapping.update( python=('https://docs.python.org/3', None), python2=('https://docs.python.org/2', None), ) + +# Add support for the unreleased "next-version" change notes +extensions += ['sphinxcontrib.towncrier'] + + +# -- Options for towncrier_draft extension -------------------------------------------- + +PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve() + +towncrier_draft_autoversion_mode = "draft" # or: 'sphinx-release', 'sphinx-version' +towncrier_draft_include_empty = True +towncrier_draft_working_directory = PROJECT_ROOT_DIR +# Not yet supported: towncrier_draft_config_path = 'pyproject.toml' # relative to cwd -- cgit v1.2.1 From fef727ff3ee6e99e31df74de76f997a8ffa59d5c Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 9 May 2021 12:49:42 -0400 Subject: Remove seemingly unneeded settings. --- docs/conf.py | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 8f3301b1..fc040cf3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,3 @@ -from pathlib import Path - - extensions = ['sphinx.ext.autodoc', 'jaraco.packaging.sphinx', 'rst.linker'] master_doc = "index" @@ -149,13 +146,5 @@ intersphinx_mapping.update( # Add support for the unreleased "next-version" change notes extensions += ['sphinxcontrib.towncrier'] - - -# -- Options for towncrier_draft extension -------------------------------------------- - -PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve() - -towncrier_draft_autoversion_mode = "draft" # or: 'sphinx-release', 'sphinx-version' -towncrier_draft_include_empty = True -towncrier_draft_working_directory = PROJECT_ROOT_DIR -# Not yet supported: towncrier_draft_config_path = 'pyproject.toml' # relative to cwd +# Extension needs a path from here to the towncrier config. +towncrier_draft_working_directory = '..' -- cgit v1.2.1 From d3cc031edaa843ad796c5e1e079c1e4b58bcec06 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Wed, 19 May 2021 11:44:40 -0400 Subject: Avoid publishing unreleased changes when there are none. --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index fc040cf3..4548cf27 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -148,3 +148,5 @@ intersphinx_mapping.update( extensions += ['sphinxcontrib.towncrier'] # Extension needs a path from here to the towncrier config. towncrier_draft_working_directory = '..' +# Avoid an empty section for unpublished changes. +towncrier_draft_include_empty = False -- cgit v1.2.1 From 918a415b41225f442d6e9b319ecebff19b52a1a5 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 18 Jul 2021 14:48:16 -0400 Subject: Implement tidelift banner using a Sphinx directive implemented by jaraco.tidelift. --- docs/conf.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index dbf962dd..bd8564ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1 @@ - -# Custom sidebar templates, maps document names to template names. -html_theme = 'alabaster' -templates_path = ['_templates'] -html_sidebars = {'index': ['tidelift-sidebar.html']} +extensions += ['jaraco.tidelift'] -- cgit v1.2.1 From 8ea55f2fb26bd77997f0e9435bab2d41376a76d4 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Fri, 17 Sep 2021 21:23:38 -0400 Subject: Add intersphinx mappings for Python to prevent spurious nitpicky failures. Fixes jaraco/skeleton#51. --- docs/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index f65d1faa..4ae74093 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,3 +27,10 @@ link_files = { # Be strict about any broken references: nitpicky = True + +# Include Python intersphinx mapping to prevent failures +# jaraco/skeleton#51 +extensions += ['sphinx.ext.intersphinx'] +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} -- cgit v1.2.1 From fb5d174dc77a63861258a8c160483ca711f307aa Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Thu, 4 Nov 2021 02:10:57 +0000 Subject: Customise the sphinx theme to reflect the new logo --- docs/conf.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ba541423..c55af0bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,6 +101,21 @@ default_role = 'any' # HTML theme html_theme = 'furo' +html_static_path = ['logo'] + +html_theme_options = { + "sidebar_hide_name": True, + "light_logo": "paths.png", + "light_css_variables": { + "color-brand-primary": "#336790", # "blue" + "color-brand-content": "#336790", + }, + "dark_logo": "paths-negative.png", + "dark_css_variables": { + "color-brand-primary": "#E5B62F", # "yellow" + "color-brand-content": "#E5B62F", + }, +} # Add support for inline tabs extensions += ['sphinx_inline_tabs'] -- cgit v1.2.1 From b7c2e2b49ca2db77051410bed87f034306222b42 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Thu, 4 Nov 2021 02:39:55 +0000 Subject: Rename logo files --- docs/conf.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index c55af0bd..06a61a8c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,16 +101,15 @@ default_role = 'any' # HTML theme html_theme = 'furo' -html_static_path = ['logo'] +html_logo = "images/logo.png" +html_static_path = ['images'] html_theme_options = { "sidebar_hide_name": True, - "light_logo": "paths.png", "light_css_variables": { "color-brand-primary": "#336790", # "blue" "color-brand-content": "#336790", }, - "dark_logo": "paths-negative.png", "dark_css_variables": { "color-brand-primary": "#E5B62F", # "yellow" "color-brand-content": "#E5B62F", -- cgit v1.2.1 From 300093105848dfbf2a95f490a92e91620d8199c0 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Thu, 4 Nov 2021 03:22:27 +0000 Subject: Add docs/README to the toctree --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 06a61a8c..4f3eb8dc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,7 +102,6 @@ default_role = 'any' # HTML theme html_theme = 'furo' html_logo = "images/logo.png" -html_static_path = ['images'] html_theme_options = { "sidebar_hide_name": True, -- cgit v1.2.1 From 8ffccbdd3b01fb1cf7248e699bcf478169cdb912 Mon Sep 17 00:00:00 2001 From: Anderson Bravalheri Date: Fri, 5 Nov 2021 20:03:03 +0000 Subject: Add favicon and related configuration to sphinx --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index 4f3eb8dc..ebb84c48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,6 +102,7 @@ default_role = 'any' # HTML theme html_theme = 'furo' html_logo = "images/logo.png" +html_favicon = "images/favicon.ico" html_theme_options = { "sidebar_hide_name": True, -- cgit v1.2.1 From 4f475e9035ff40906024249e81b2f7e5b9bebf14 Mon Sep 17 00:00:00 2001 From: Sviatoslav Sydorenko Date: Thu, 11 Nov 2021 15:57:01 +0100 Subject: Document that pip works with editable setup.cfg --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index ebb84c48..d352a481 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,3 +171,5 @@ towncrier_draft_working_directory = '..' towncrier_draft_include_empty = False extensions += ['jaraco.tidelift'] + +intersphinx_mapping['pip'] = 'https://pip.pypa.io/en/latest', None -- cgit v1.2.1