https://github.com/ask/sphinx2rst
Convert basic Sphinx format to reStructuredText.
https://github.com/ask/sphinx2rst
Last synced: 5 months ago
JSON representation
Convert basic Sphinx format to reStructuredText.
- Host: GitHub
- URL: https://github.com/ask/sphinx2rst
- Owner: ask
- License: other
- Created: 2016-04-08T01:47:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-27T18:30:54.000Z (over 9 years ago)
- Last Synced: 2024-04-23T17:07:13.911Z (about 2 years ago)
- Language: Python
- Size: 5.86 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: Changelog
- License: LICENSE
Awesome Lists containing this project
README
=====================================================================
Sphinx2RST
=====================================================================
:Version: 1.0.0
:Download: http://pypi.python.org/pypi/sphinx2rst/
:Source: http://github.com/ask/sphinx2rst/
:Keywords: Sphinx, documentation, python
About
=====
The ``sphinx2rst`` command, converts basic Sphinx markup to
pure reStructuredText format.
.. _installation:
Installation
============
You can install sphinx2rst the Python Package Index (PyPI)
or from source.
To install using `pip`,::
$ pip install -U sphinx2rst
To install using `easy_install`,::
$ easy_install -U sphinx2rst
.. _installing-from-source:
Downloading and installing from source
--------------------------------------
Download the latest version of sphinx2rst from
http://pypi.python.org/pypi/sphinx2rst
You can install it by doing the following,::
$ tar xvfz sphinx2rst-0.0.0.tar.gz
$ cd spinx2rst-0.0.0
$ python setup.py build
# python setup.py install
The last command must be executed as a privileged user if
you are not currently using a virtualenv.
.. _installing-from-git:
Using the development version
-----------------------------
With pip
~~~~~~~~
You can install the latest snapshot of sphinx2rst using the following
pip command::
$ pip install https://github.com/ask/sphinx2rst#egg=sphinx2rst