Skip to main content

A MdBook documentation builder plugin for the Pants buildsystem.

Project description

MDBook backend for Pants

PyPI

Warning This plugin is in development. No stability is guaranteed! Contributions welcome.

This provides a tool for building mdbook targets with pants. There is currently a single very simple rule:

md_book(
    name="my-docs",
    sources=["book.toml", "src/*"],
)
Argument Meaning Default value
name The target name Same as any other target, which is the directory name
sources Files included when building the book book.toml and the src directory
decsription A description of the target ""
tags List of tags []

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pants_backend_mdbook-0.5.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

pants_backend_mdbook-0.5.0-py2.py3-none-any.whl (8.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pants_backend_mdbook-0.5.0.tar.gz.

File metadata

  • Download URL: pants_backend_mdbook-0.5.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.20

File hashes

Hashes for pants_backend_mdbook-0.5.0.tar.gz
Algorithm Hash digest
SHA256 0e10c0faffca3b2593c7533fb455c51351ce37be6314a84031d35b3eb59ba899
MD5 199775cc06320f3b94af76b87b071617
BLAKE2b-256 a47f981b4380df5f451d84bb6a1371c2e77e860771408a2f681d8a4c5728af88

See more details on using hashes here.

Provenance

File details

Details for the file pants_backend_mdbook-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pants_backend_mdbook-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e55bf8806168a6b83465e0e822da959bdf7c1d264867168269b389893d62ab88
MD5 80233d71b2cf2980a4fe53c6b5ec7644
BLAKE2b-256 ba765500737a0715c901806a919805f3f5cab6dda4412add5cb9bbf0e2323cb1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page