pypi-sphinx-flexlate-example 0.61.0

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

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:

import pypi_sphinx_flexlate_example

# Do something with pypi_sphinx_flexlate_example

See a more in-depth tutorial here.

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

First, you need a couple global dependencies installed, see their documentation for details:

• direnv
• asdf

Note that these tools require a UNIX-style shell, such as bash or zsh. If you are on Windows, you can use WSL or Git Bash. If you are using Pycharm, you can configure the built-in terminal to use Git Bash.

Then clone the repo and run direnv allow. This will take a while on the first time to install the remaining dependencies.

Make your changes and then run just to run formatting, linting, and tests.

Develop documentation by running just docs to start up a dev server.

To run tests only, run just test. You can pass additional arguments to pytest, e.g. just test -k test_something.

Prior to committing, you can run just with no arguments to run all the checks.

Author

Created by Nick DeRobertis. MIT License.

Links

See the documentation here.