Skip to main content


Project 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.


The easiest way to install sphinx-me is directly from PyPI using pip or setuptools by running the respective command below:

$ pip install -U sphinx-me


$ easy_install -U sphinx-me

Otherwise you can download sphinx-me and install it directly from source:

$ python install


sphinx-me will be installed as a system-wide script that can be run from the command line while in your project’s root directory:

$ sphinx-me

When run in your project’s directory, it will create a docs directory with two files, the Sphinx module, and an index.rst file which will include your project’s README.

The module calls a setup function from sphinx-me that sets up the minimum required settings for your Sphinx docs.

  • project - the directory name of your project is used.

  • version - retrieved from the version arg of your script, or your package’s __version__ attribute.

  • copyright - retrieved from the author arg of your script, or your package’s __author__ attribute.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-me-0.1.2.tar.gz (5.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page