Merge pull request #14 from Pylons/feature-add-contributing-update-docs

Feature add contributing update docs

CHANGES.rst

@@ -8,6 +8,9 @@ Changes
 
 - Drop support for Python 2.6, 3.2 and 3.3.
 
+- Add contributing.md and update docs. See
+  https://github.com/Pylons/peppercorn/issues/13
+
 
 0.5 (2014-09-29)
 ----------------

CONTRIBUTORS.txt

@@ -107,3 +107,4 @@ Contributors
 - Shane Hathaway, 2013/04/13
 - Tim Tisdall, 2015/04/21
 - Steffen Allner, 2018/08/14
+- Steve Piercy, 2018/08/08

contributing.md

@@ -0,0 +1,28 @@
+Contributing
+============
+
+All projects under the Pylons Projects, including this one, follow the
+guidelines established at [How to
+Contribute](https://pylonsproject.org/community-how-to-contribute.html) and
+[Coding Style and
+Standards](https://pylonsproject.org/community-coding-style-standards.html).
+
+You can contribute to this project in several ways.
+
+* [File an Issue on GitHub](https://github.com/Pylons/peppercorn/issues)
+* Fork this project and create a branch with your suggested change. When ready,
+  submit a pull request for consideration. [GitHub
+  Flow](https://guides.github.com/introduction/flow/index.html) describes the
+  workflow process and why it's a good practice. When submitting a pull
+  request, sign
+  [CONTRIBUTORS.txt](https://github.com/Pylons/peppercorn/blob/master/CONTRIBUTORS.txt)
+  if you have not yet done so.
+* Join the IRC channel #pyramid on irc.freenode.net.
+
+Git Branches
+------------
+Git branches and their purpose and status at the time of this writing are
+listed below.
+
+* [master](https://github.com/Pylons/peppercorn/) - The branch on which further
+  development takes place. The default branch on GitHub.

docs/conf.py

@@ -12,44 +12,16 @@
 # All configuration values have a default value; values that are commented
 # out serve to show the default value.
 
-import sys, os
-
-# Add and use Pylons theme
-if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
-    from subprocess import call, Popen, PIPE
-
-    p = Popen('which git', shell=True, stdout=PIPE)
-    git = p.stdout.read().strip()
-    cwd = os.getcwd()
-    _themes = os.path.join(cwd, '_themes')
-
-    if not os.path.isdir(_themes):
-        call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git',
-                '_themes'])
-    else:
-        os.chdir(_themes)
-        call([git, 'checkout', 'master'])
-        call([git, 'pull'])
-        os.chdir(cwd)
-
-    sys.path.append(os.path.abspath('_themes'))
-
-    parent = os.path.dirname(os.path.dirname(__file__))
-    sys.path.append(os.path.abspath(parent))
-    wd = os.getcwd()
-    os.chdir(parent)
-    os.system('%s setup.py test -q' % sys.executable)
-    os.chdir(wd)
-
-    for item in os.listdir(parent):
-        if item.endswith('.egg'):
-            sys.path.append(os.path.join(parent, item))
-
-html_theme_path = ['_themes']
+import pylons_sphinx_themes
+import datetime
+
+
+html_theme_path = pylons_sphinx_themes.get_html_themes_path()
 html_theme = 'pylons'
 html_theme_options = dict(
     github_url='https://github.com/Pylons/peppercorn',
-#    in_progress='true'
+    canonical_url='https://docs.pylonsproject.org/projects/peppercorn/en/latest/'
+    #    in_progress='true'
     )
 
 
@@ -76,7 +48,9 @@
 
 # General substitutions.
 project = 'peppercorn'
-copyright = '2011, Agendaless Consulting <pylons-discuss@googlegroups.com>'
+thisyear = datetime.datetime.now().year
+copyright = '2011-%s, Agendaless Consulting ' \
+            '<pylons-discuss@googlegroups.com>' % thisyear
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
@@ -156,9 +130,8 @@
 # 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
+# Do not use smart quotes.
+smartquotes = False
 
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}

docs/glossary.rst

@@ -7,5 +7,4 @@ Glossary
    :sorted:
 
    WebOb
-     `WebOb <http://pythonpaste.org/webob/>`_ is a WSGI request/response
-     library created by Ian Bicking.
+     `WebOb <https://webob.org/>`_ is a WSGI request/response library created by Ian Bicking.

rtd.txt

@@ -0,0 +1 @@
+-e .[docs]

setup.py

@@ -28,6 +28,11 @@
 
 requires = []
 
+docs_extras = [
+    'Sphinx >= 1.7.6',
+    'pylons-sphinx-themes',
+]
+
 setup(
     name='peppercorn',
     version='0.5',
@@ -59,6 +64,9 @@
     zip_safe=False,
     tests_require = requires,
     install_requires = requires,
+    extras_require={
+        'docs': docs_extras,
+    },
     test_suite="peppercorn",
     )