Example output for https://github.com/nickderobertis/copier-pypi-sphinx-flexlate
Project description
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:
Then clone the repo and run npm install
and pipenv sync
. Run pipenv shell
to use the virtual environment. Make your changes and then run nox
to run formatting,
linting, and tests.
Develop documentation by running nox -s docs
to start up a dev server.
To run tests only, run nox -s test
. You can pass additional arguments to pytest
by adding them after --
, e.g. nox -s test -- -k test_something
.
Author
Created by Nick DeRobertis. MIT License.
Links
See the documentation here.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pypi-sphinx-flexlate-example-0.42.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6584ca6f4e5d2da94bf37b8e4988bf3864ef29c3cee344c1d6f66552c0a44da |
|
MD5 | f53728a01da2c1013f04edb14377dfff |
|
BLAKE2b-256 | 6c001231ca3442f96e9ed30e1a22abedabe1fd86999e17eef449637a1d55d488 |
Hashes for pypi_sphinx_flexlate_example-0.42.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c327a07f003486bf4b46aa4e05148e57ce054a979f464b6c92470cd70cd19ec |
|
MD5 | d18744ef6d8dd005480acf5db6d8ad7e |
|
BLAKE2b-256 | 5dd99942c09b324e7273bfc1aaeb02a091524cbf3f80095d02542229e63cd19f |