mudkip 0.2.0

A friendly Sphinx wrapper

📘 mudkip

A friendly Sphinx wrapper.

🚧 Work in progress 🚧

Mudkip is a small wrapper around Sphinx that bundles essential tools and extensions, providing everything needed for most day-to-day documentation.

$ mudkip --help
Usage: mudkip [OPTIONS] COMMAND [ARGS]...

  A friendly Sphinx wrapper.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  build    Build documentation.
  clean    Remove output directory.
  develop  Start development server.
  init     Initialize documentation.
  test     Test documentation.

Features

Mudkip intends to provide an out-of-the-box solution for small to medium projects. The command-line utility lets you build and check your documentation, launch a development server with live reloading, run doctests and more!

Mudkip enables the following Sphinx extensions:

• sphinx.ext.autodoc for generating documentation from docstrings
• sphinx.ext.napoleon for Google-style and NumPy-style docstrings support
• sphinx_autodoc_typehints for pulling type information from Python 3 annotations
• sphinx.ext.doctest for doctest support
• recommonmark for markdown support
• nbsphinx for Jupyter notebook support

Installation

The package can be installed with pip.

$ pip install mudkip

Usage

TODO

Contributing

Contributions are welcome. This project uses poetry.

$ poetry install

The code follows the black code style.

$ poetry run black mudkip

---

License - MIT