textproc/py-sphinx-me 0.3_1 MidnightBSD
Wrap README-only projects in a dynamic Sphinx shell
- System
- MidnightBSD
- Repository
- mports
- Maintainer
- [email protected]
- License
- bsd2
- Categories
- textproc, python
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
| System | Port | Version |
|---|---|---|
| MidnightBSD | textproc/py-sphinx-me | 0.3_1 |
| FreeBSD | textproc/py-sphinx-me | 0.3_1 |
| DragonFly | textproc/py-sphinx-me | 0.3_1 |
| HardenedBSD | textproc/py-sphinx-me | 0.3_1 |
| GhostBSD | textproc/py-sphinx-me | 0.3_1 |
Install
Binary package:
mport install ${PYTHON_PKGNAMEPREFIX}sphinx-me
From mports:
cd /usr/mports/textproc/py-sphinx-me && make install clean
To depend on this port in another port's Makefile:
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}sphinx-me>0:textproc/py-sphinx-me
Dependencies
No port depends on this one.
Configuration
No options to configure.
- USES
- python
- Service scripts
- none
Files
distinfo 1
| File | Size | SHA256 |
|---|---|---|
| sphinx-me-0.3.tar.gz | 5682 | 98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a |
Master sites 1
- PYPI