https://github.com/nickderobertis/pypi-sphinx-flexlate-example

https://github.com/nickderobertis/pypi-sphinx-flexlate-example

flexlate multi-word-example pypi sphinx

Last synced: about 3 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/nickderobertis/pypi-sphinx-flexlate-example
• Owner: nickderobertis
• License: mit
• Created: 2022-05-22T10:58:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-23T20:16:30.000Z (about 1 year ago)
• Last Synced: 2024-04-24T13:22:15.444Z (9 months ago)
• Topics: flexlate, multi-word-example, pypi, sphinx
• Language: Python
• Size: 1.67 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![](https://codecov.io/gh/nickderobertis/pypi-sphinx-flexlate-example/branch/main/graph/badge.svg)](https://codecov.io/gh/nickderobertis/pypi-sphinx-flexlate-example)

[![PyPI](https://img.shields.io/pypi/v/pypi-sphinx-flexlate-example)](https://pypi.org/project/pypi-sphinx-flexlate-example/)

![PyPI - License](https://img.shields.io/pypi/l/pypi-sphinx-flexlate-example)

[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/pypi-sphinx-flexlate-example/)

![Tests Run on Ubuntu Python Versions](https://img.shields.io/badge/Tests%20Ubuntu%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

![Tests Run on Macos Python Versions](https://img.shields.io/badge/Tests%20Macos%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

![Tests Run on Windows Python Versions](https://img.shields.io/badge/Tests%20Windows%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/pypi-sphinx-flexlate-example/)

#  pypi-sphinx-flexlate-example

## Overview

Example output for https://github.com/nickderobertis/copier-pypi-sphinx-flexlate

## Getting Started

Install `pypi-sphinx-flexlate-example`:

```

pip install pypi-sphinx-flexlate-example

```

A simple example:

```python

import pypi_sphinx_flexlate_example

# Do something with pypi_sphinx_flexlate_example

```

See a

[more in-depth tutorial here.](

https://nickderobertis.github.io/pypi-sphinx-flexlate-example/tutorial.html

)

## Links

See the

[documentation here.](

https://nickderobertis.github.io/pypi-sphinx-flexlate-example/

)

## Development Status

This project is currently in early-stage development. There may be

breaking changes often. While the major version is 0, minor version

upgrades will often have breaking changes.

## Developing

See the [development guide](

https://github.com/nickderobertis/pypi-sphinx-flexlate-example/blob/main/DEVELOPING.md

) for development details.

## Author

Created by Nick DeRobertis. MIT License.