Date: Wed, 27 Apr 2016 18:16:26 +0000 (UTC) From: Rene Ladan <rene@FreeBSD.org> To: ports-committers@freebsd.org, svn-ports-all@freebsd.org, svn-ports-head@freebsd.org Subject: svn commit: r414125 - in head/textproc: . py-sphinx-me Message-ID: <201604271816.u3RIGQrK061022@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: rene Date: Wed Apr 27 18:16:26 2016 New Revision: 414125 URL: https://svnweb.freebsd.org/changeset/ports/414125 Log: 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/ Added: head/textproc/py-sphinx-me/ head/textproc/py-sphinx-me/Makefile (contents, props changed) head/textproc/py-sphinx-me/distinfo (contents, props changed) head/textproc/py-sphinx-me/pkg-descr (contents, props changed) Modified: head/textproc/Makefile Modified: head/textproc/Makefile ============================================================================== --- head/textproc/Makefile Wed Apr 27 18:09:06 2016 (r414124) +++ head/textproc/Makefile Wed Apr 27 18:16:26 2016 (r414125) @@ -1289,6 +1289,7 @@ SUBDIR += py-sparqlwrapper SUBDIR += py-sphinx SUBDIR += py-sphinx-intl + SUBDIR += py-sphinx-me SUBDIR += py-sphinx_numfig SUBDIR += py-sphinx_rtd_theme SUBDIR += py-sphinx_wikipedia Added: head/textproc/py-sphinx-me/Makefile ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-sphinx-me/Makefile Wed Apr 27 18:16:26 2016 (r414125) @@ -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> Added: head/textproc/py-sphinx-me/distinfo ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-sphinx-me/distinfo Wed Apr 27 18:16:26 2016 (r414125) @@ -0,0 +1,2 @@ +SHA256 (sphinx-me-0.3.tar.gz) = 98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a +SIZE (sphinx-me-0.3.tar.gz) = 5682 Added: head/textproc/py-sphinx-me/pkg-descr ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/textproc/py-sphinx-me/pkg-descr Wed Apr 27 18:16:26 2016 (r414125) @@ -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/
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201604271816.u3RIGQrK061022>