Skip to content

Commit 23fd64a

Browse files
committed
Convert to a package
Now that we have split the file out into its own repo, we can go about packaging things up. We use pbr because it's lets us avoid a load of boilerplate. Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent 6174883 commit 23fd64a

15 files changed

+155
-0
lines changed

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# Distribution / packaging
7+
dist/
8+
eggs/
9+
.eggs/
10+
*.egg-info/
11+
*.egg
12+
13+
# Unit test / coverage reports
14+
.tox/
15+
16+
# Sphinx documentation
17+
docs/_build/
18+
19+
# pbr
20+
AUTHORS
21+
ChangeLog
22+
23+
# virtualenv
24+
/.venv

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
========
2+
pwclient
3+
========
4+
5+
TODO.

docs/conf.py

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# pwclient documentation build configuration file
4+
5+
try:
6+
import sphinx_rtd_theme # noqa
7+
has_rtd_theme = True
8+
except ImportError:
9+
has_rtd_theme = False
10+
11+
# -- General configuration ------------------------------------------------
12+
13+
# If your documentation needs a minimal Sphinx version, state it here.
14+
needs_sphinx = '1.5'
15+
16+
# Add any Sphinx extension module names here, as strings. They can be
17+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
18+
# ones.
19+
extensions = ['reno.sphinxext']
20+
21+
# The master toctree document.
22+
master_doc = 'contents'
23+
24+
# General information about the project.
25+
project = u'pwclient'
26+
copyright = u'2018, Stephen Finucane'
27+
author = u'Stephen Finucane'
28+
29+
# The name of the Pygments (syntax highlighting) style to use.
30+
pygments_style = 'sphinx'
31+
32+
# -- Options for HTML output ----------------------------------------------
33+
34+
# The theme to use for HTML and HTML Help pages. See the documentation for
35+
# a list of builtin themes.
36+
#
37+
if has_rtd_theme:
38+
html_theme = 'sphinx_rtd_theme'

docs/contents.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Contents
2+
========
3+
4+
.. toctree::
5+
6+
index
7+
usage
8+
release-notes

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
pwclient
2+
========
3+
4+
TODO.

docs/release-notes.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Release Notes
2+
=============
3+
4+
.. release-notes::

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx>=1.7,<2.0
2+
reno>=2.0,<3.0
3+
sphinx_rtd_theme

docs/usage.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Usage
2+
=====
3+
4+
TODO

pwclient/__init__.py

Whitespace-only changes.
File renamed without changes.

0 commit comments

Comments
 (0)