textproc/py-sphinx-me 0.3_1
Wrap README-only projects in a dynamic Sphinx shell
- Repository
- FreeBSD ports
- Maintainer
- [email protected]
- License
- BSD2CLAUSE
- Categories
- textproc, python
- Package size
- 10.8 KiB, 28.6 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.
Install
As a binary package — by origin, or by package name:
pkg install textproc/py-sphinx-me
pkg install py312-sphinx-meFrom the ports tree:
cd /usr/ports/textproc/py-sphinx-me/ && make install cleanTo depend on this port in another port's Makefile:
RUN_DEPENDS= py312-sphinx-me>0:textproc/py-sphinx-mePackages
The version each package repository carries. “-” means the repository builds no package of it, “n/a” that there is no such repository.
| Repository | aarch64 | amd64 | armv6 | armv7 | i386 |
|---|---|---|---|---|---|
| FreeBSD:14:latest | 0.3_1 | 0.3_1 | 0.3 | 0.3_1 | 0.3_1 |
| FreeBSD:14:quarterly | 0.3_1 | 0.3_1 | n/a | 0.3_1 | 0.3_1 |
| FreeBSD:15:latest | 0.3_1 | 0.3_1 | n/a | 0.3_1 | 0.3_1 |
| FreeBSD:15:quarterly | 0.3_1 | 0.3_1 | n/a | n/a | n/a |
| FreeBSD:16:latest | 0.3_1 | 0.3_1 | n/a | n/a | n/a |
| FreeBSD:16:quarterly | n/a | n/a | n/a | n/a | n/a |
Dependencies
The Makefile names none itself; they come from USES and USE_*.
The full lists below include those, and their dependencies in turn.
All build dependencies 11
All run dependencies 7
No port depends on this one.
Configuration
No options to configure.
- USES
- python
- Service scripts
- none
Message after installing
===> NOTICE: The py312-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
Files
distinfo 1
| File | Size | SHA256 |
|---|---|---|
| sphinx-me-0.3.tar.gz | 5682 | 98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a |
Master sites 1
- PYPI
Commit history 0
No commits in the history this site was built from.