Metadata-Version: 2.4
Name: sphinx-variations
Version: 1.1.0
Summary: Create multiple variations of your Sphinx HTML documentation.
Home-page: https://github.com/treamology/sphinx-variations
Author: D. Lawrence
Author-email: trea@treamous.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Sphinx
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

# sphinx-variations

A Sphinx extension that allows project maintainers to create multiple variations of their documentation, based on its usage of the `.. only` directive. Each variation contains a Sphinx tag and a friendly name.

## How to Use

### Installing
sphinx-variations is available on PyPi:

```
python3 -m pip install sphinx-variations
```

After installing the package, list the extension in your Sphinx project's `conf.py`.

```
extensions = [..., 'variations']
```

### Configuration

To create multiple variations for your docs, a list of tags to use as variations can be inserted into your `conf.py` file:

```
variations = [( [tagname], [friendly name] )]
```

For example:

```
variations = [('python', 'Python'),
              ('cpp', 'C++')]
```

The above will cause two copies of the documentation text to be made, each in a directory with the tag name. Static files are not copied between the two variations, but are shared between them.

### Template Variables
This extension also provides two template variables, `variations` and `currentvariation`.

`variations` contains the complete list of variations in the same format specified above, and `currentvariation` contains the tuple for the current variation.

These variables can be used to create links between the different variations of your documentation, for example.

# License
MIT, see `LICENSE`.
