py27-sphinx-me - Wrap README-only projects in a dynamic Sphinx shell
||FreeBSD Ports Quarterly i386
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.
The py27-sphinx-me port currently does not have a maintainer. As a result, it is
more likely to have unresolved issues, not be up-to-date, or even be removed in
the future. To volunteer to maintain this port, please create an issue at:
More information about port maintainership is available at:
Install py27-sphinx-me txz package:
# pkg install py27-sphinx-me