blackdoc

run black on documentation code snippets

MIT License

Downloads
18K
Stars
47
Committers
6
blackdoc - v0.3.9 Latest Release

Published by keewis 12 months ago

New Features

  • version hook: allow synchronizing the version with the pre-commit mirror (#180)

Maintenance

  • drop support for running on the EOL'ed python 3.7 (#186)
  • officially support running on python 3.12 (#185)
blackdoc - v0.3.8

Published by keewis almost 2 years ago

New features

  • use rich instead of custom color printing code (#146, #157, #159, #160)

Bug fixes

  • support doctest lines in rST code blocks (#150, #151)
  • split chained statements into multiple doctest lines (#143, #155, #158)

Maintenance

  • drop support for python 3.6 (#153)
  • officially support python 3.11 (#163, #164)
blackdoc - v0.3.7

Published by keewis about 2 years ago

Bug fixes:

  • rewrite the triple-quote reconstruction algorithm to finally fix the regression from v0.3.5 (#144)

New features:

  • switch to the furo theme (#149)
  • add a hook to synchronize the version of black from the black hook with the one from additional_dependencies (#124)
blackdoc - v0.3.6

Published by keewis about 2 years ago

Bug fixes:

  • fix a regression in the doctest format where we would either truncate the reformatted code or crash (#137)
blackdoc - v0.3.5

Published by keewis over 2 years ago

New features:

  • colorize removed trailing whitespace in diffs (#120)
  • officially support python 3.10 (#115)

Bug fixes:

  • write only if the content of a file changed (#127, #128)
  • don't crash on strings with trailing empty strings, like "a""" (#131, #132)
blackdoc - v0.3.4

Published by keewis over 3 years ago

Bug fixes:

  • declare the direct dependency on toml (#100, #101)
blackdoc - v0.3.3

Published by keewis over 3 years ago

Bug fixes:

  • don't crash on rst code blocks missing a newline between the options and the code
blackdoc - v0.3.2

Published by keewis almost 4 years ago

Bug fixes:

  • keep newlines immediately before the end of the file in reStructuredText files
blackdoc - v0.3.1

Published by keewis almost 4 years ago

Bug fixes:

  • doctest: don't detect comments ending with a colon as blocks
  • don't use ANSI codes if we're not printing to a TTY
blackdoc - Release v0.3

Published by keewis almost 4 years ago

New features:

  • color the output
  • support the --diff and --color / --no-color options
  • support skipping string normalization
  • make sure blocks end with a empty continuation line

Bug fixes:

  • make the ordering of the formatted files more predictable
blackdoc - Release v0.2

Published by keewis almost 4 years ago

Bug fixes:

  • fix formatting empty doctest lines
  • don't change the triple quote style of nested docstrings

New features:

  • add support for the testcode rst directives
  • read settings from a configuration file
  • add the --force-exclude option
blackdoc - Release v0.1.2

Published by keewis almost 4 years ago

Bugfix release:

  • keep compatibility with black version 20.8b1
blackdoc - Release v0.1.1

Published by keewis almost 4 years ago

Fixed bugs / new features:

  • always return a non-zero error code if there was an error
  • add a pre-commit hook configuration
blackdoc - Release v0.1.0

Published by keewis almost 4 years ago

The initial release