https://github.com/coddingtonbear/sphinx-measurement

Easily mark-up and convert measurements between various measures.
https://github.com/coddingtonbear/sphinx-measurement

Last synced: 20 days ago
JSON representation

Easily mark-up and convert measurements between various measures.

• Host: GitHub
• URL: https://github.com/coddingtonbear/sphinx-measurement
• Owner: coddingtonbear
• Created: 2016-06-23T06:35:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-27T03:56:03.000Z (over 8 years ago)
• Last Synced: 2024-10-19T12:37:46.996Z (2 months ago)
• Language: Python
• Size: 2.93 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Sphinx-Measurement

Easily mark-up and convert between various measures.

## Installation

Install from pip --

```

pip install sphinx-measurement

```

And, add ``sphinx_measurement`` to your ``extensions`` list in your Sphinx

project's configuration.

```

extensions = [

    # other extensions

    'sphinx_measurement',

]

```

## Basic Use

Marking-up a measurement:

```

Mount everest is :measurement:`29029 ft as everest-height` feet tall.

```

And when you later want to talk about that measurement in a different

measurement system:

```

That's :measurement:`everest-height in m` meters tall for those of you living

in countries using a sane measurement system.

```