diff options
author | Rene Ladan <rene@FreeBSD.org> | 2016-04-27 18:16:26 +0000 |
---|---|---|
committer | Rene Ladan <rene@FreeBSD.org> | 2016-04-27 18:16:26 +0000 |
commit | c47e1294f6e3bea3bc26ce81d240a9e506a49520 (patch) | |
tree | 63bd3ae619bdd0ff749d2ba63229eec1e9d26c04 /textproc/Makefile | |
parent | e7f77316589f3724e019d9dc83c945c228fe791f (diff) | |
download | ports-c47e1294f6e3bea3bc26ce81d240a9e506a49520.tar.gz ports-c47e1294f6e3bea3bc26ce81d240a9e506a49520.zip |
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/
Notes
Notes:
svn path=/head/; revision=414125
Diffstat (limited to 'textproc/Makefile')
-rw-r--r-- | textproc/Makefile | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/textproc/Makefile b/textproc/Makefile index a33067496b17..2578f4001719 100644 --- a/textproc/Makefile +++ b/textproc/Makefile @@ -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 |