BSD Ports

textproc/py-sphinx-me 0.3_1 DragonFly

Wrap README-only projects in a dynamic Sphinx shell

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
BSD2CLAUSE
Categories
python, textproc
Package size
10.1 KiB, 33.1 KiB installed

Description

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.

In the other systems

SystemPortVersion
DragonFlytextproc/py-sphinx-me0.3_1
FreeBSDtextproc/py-sphinx-me0.3_1
MidnightBSDtextproc/py-sphinx-me0.3_1
HardenedBSDtextproc/py-sphinx-me0.3_1
GhostBSDtextproc/py-sphinx-me0.3_1

Install

Binary package:

pkg install py311-sphinx-me

From DPorts:

cd /usr/dports/textproc/py-sphinx-me && make install clean

Dependencies

Run dependencies 1

No port depends on this one.

Configuration

No options to configure.

Service scripts
none

Message after installing

===>   NOTICE:

The py311-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:

https://bugs.freebsd.org/bugzilla

More information about port maintainership is available at:

https://docs.freebsd.org/en/articles/contributing/#ports-contributing