aboutsummaryrefslogtreecommitdiff
path: root/textproc/py-sphinx-me
diff options
context:
space:
mode:
authorRene Ladan <rene@FreeBSD.org>2016-04-27 18:16:26 +0000
committerRene Ladan <rene@FreeBSD.org>2016-04-27 18:16:26 +0000
commitc47e1294f6e3bea3bc26ce81d240a9e506a49520 (patch)
tree63bd3ae619bdd0ff749d2ba63229eec1e9d26c04 /textproc/py-sphinx-me
parente7f77316589f3724e019d9dc83c945c228fe791f (diff)
downloadports-c47e1294f6e3bea3bc26ce81d240a9e506a49520.tar.gz
ports-c47e1294f6e3bea3bc26ce81d240a9e506a49520.zip
Notes
Diffstat (limited to 'textproc/py-sphinx-me')
-rw-r--r--textproc/py-sphinx-me/Makefile20
-rw-r--r--textproc/py-sphinx-me/distinfo2
-rw-r--r--textproc/py-sphinx-me/pkg-descr15
3 files changed, 37 insertions, 0 deletions
diff --git a/textproc/py-sphinx-me/Makefile b/textproc/py-sphinx-me/Makefile
new file mode 100644
index 000000000000..69e788c05bcc
--- /dev/null
+++ b/textproc/py-sphinx-me/Makefile
@@ -0,0 +1,20 @@
+# Created by: René Ladan <rene@freebsd.org>
+# $FreeBSD$
+
+PORTNAME= sphinx-me
+PORTVERSION= 0.3
+CATEGORIES= textproc python
+MASTER_SITES= CHEESESHOP
+PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
+
+MAINTAINER= rene@FreeBSD.org
+COMMENT= Wrap README-only projects in a dynamic Sphinx shell
+
+LICENSE= BSD2CLAUSE
+LICENSE_FILE= ${WRKSRC}/LICENSE
+
+USES= python
+USE_PYTHON= autoplist distutils
+NO_ARCH= yes
+
+.include <bsd.port.mk>
diff --git a/textproc/py-sphinx-me/distinfo b/textproc/py-sphinx-me/distinfo
new file mode 100644
index 000000000000..ae6c327bebe2
--- /dev/null
+++ b/textproc/py-sphinx-me/distinfo
@@ -0,0 +1,2 @@
+SHA256 (sphinx-me-0.3.tar.gz) = 98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a
+SIZE (sphinx-me-0.3.tar.gz) = 5682
diff --git a/textproc/py-sphinx-me/pkg-descr b/textproc/py-sphinx-me/pkg-descr
new file mode 100644
index 000000000000..eab8cb9c21d7
--- /dev/null
+++ b/textproc/py-sphinx-me/pkg-descr
@@ -0,0 +1,15 @@
+Do you have smaller Python projects that only need a README file for
+documentation? Want to host your README on Read The Docs?
+
+sphinx-me is a BSD licensed tool that will create a Sphinx documentation shell
+for your project and include the README file as the documentation index. It
+handles extracting the required meta data such as the project name, author and
+version from your project for use in your Sphinx docs.
+
+Once you use sphinx-me to build your Sphinx docs, you can then add your project
+to the Read The Docs site and have your project's README hosted with an
+attractive Sphinx documentation theme.
+
+Your README file should be in a reStructuredText compatible format.
+
+WWW: https://github.com/stephenmcd/sphinx-me/