mirror of
https://git.FreeBSD.org/ports.git
synced 2024-12-18 03:46:03 +00:00
c47e1294f6
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/
16 lines
725 B
Plaintext
16 lines
725 B
Plaintext
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/
|