rstcloth

A simple Python API for generating RestructuredText.

OTHER License

Downloads
12.1K
Stars
28
Committers
11

Bot releases are visible (Hide)

rstcloth - Add simple table Latest Release

Published by github-actions[bot] 9 months ago

Contents (#52)

New features

  • adding simple table, tests, and some parameterized tests
  • Bump version for simple_table feature

Operations

  • Remove unnecessary math dependency from docs

Uncategorised!

  • Merge pull request #50 from joej164/add-simple-table-#44
rstcloth - Widen python requirement to prevent prohibitive installs

Published by github-actions[bot] 9 months ago

Contents (#51)

Operations

  • Widen python requirement to prevent prohibitive installs
rstcloth - Update dependencies and DevOps processes

Published by github-actions[bot] 11 months ago

Contents (#49)

Operations

  • Update checkout workflow to avoid deprecated node12 warning
  • Update the pull request action
  • Bump verison for updated dependencies
  • Remove codecov_token for public repo

Dependencies

  • Synchronize python lockfile
  • Update locks
rstcloth - Update CD and widen dependency ranges

Published by github-actions[bot] over 1 year ago

Contents (#41)

Fixes

  • Make version consistent to circumvent release problems
  • Remove redundant pypi test deployment

Operations

  • Version bump
  • Remove duplicated CI on merge of branch
  • Update pre-commit to use consistent isort
  • Update devcontainer to new feature spec and poetry install
  • Add comment to marketplace page
  • Upgrade poetry release flow

Dependencies

  • Widen tabulate version range
  • Update devdependencies
  • Make lock file consistent
  • Allow pyyaml version 5
  • Adjust requirement syntax

Refactoring

  • Remove unused mkver.conf

Uncategorised!

  • Merge pull request #35 from thclark/fix-issue-#34
  • Merge pull request #39 from elupus/patch-1
  • Merge pull request #40 from thclark/fix-devops
rstcloth - Update python and sphinx ranges

Published by github-actions[bot] over 1 year ago

Contents (#33)

Operations

  • Update pre-commit standards
  • Update semantic version checker

Dependencies

  • Update test matrix to include python 3.11 per #32
  • Expand sphinx range per #30

Style

  • Apply updated pre-commit rules throughout
rstcloth - Update cd name

Published by github-actions[bot] over 2 years ago

rstcloth - Minor docs updates

Published by github-actions[bot] over 2 years ago

Contents (#28)

Operations

  • Version increment for minor docs fixes
  • Ensure coverage and test status is accessible on main branch

Chores

  • Ensure coverage omits non-python directories

Other

  • Update developer notes and badges in README
  • Update version history to point to autogenerated releases
  • Update default branch for coverage badge
rstcloth - Amateja updates

Published by github-actions[bot] over 2 years ago

Contents (#27)

Incorporates extensive and excellent work from @amateja - Thanks very much Andrzej!

Features

  • Use tabulate to replace table handling code as suggested in thclark/rstcloth#9.
    BREAKING CHANGE: tabulate is now a dependency.

  • Add list-table support

  • Store reStructuredText data into stream instead of list (faster, especially if piping into a file)
    BREAKING CHANGE: The RstCloth().data property is no longer a list but a stream, by default going to sys.stdout
    BREAKING CHANGE: The write() method was removed. Instead of:

    your_doc.write(output_filename)
    

    You can either open the doc in an open context:

    with open(output_filename, "w", encoding="utf-8") as fp:
        d = RstCloth(fp)
        d.title('Example Use')
    

    Or, for minimal changes to your code if you were already using write, create the doc as you would before, but stream into a memory buffer, then write to file at the end:

    import io
    d = RstCloth(stream=io.StringIO())
    d.title('Example Use')
    with open(output_filename, "w", encoding="utf-8") as fp:
        fp.write(str(d))
    
  • List table width and widths options expansion

  • Admonitions added

  • Bibliographic fields added

  • Raw directives added

  • Contents directive added

  • Transition marker added

Enhancements

  • Field structure and wrapping improved
    BREAKING-CHANGE: Indentation and wrapping may change (although all documents should still render)
  • Table indentation improved
  • Parameter type verification changed to type declaration
  • Type annotations added and docstrings supplemented
  • Quick start documentation updated and unified

Fixes

  • Fixed incorrect formatting of long bullet list point
  • Paragraph folding fixed
  • Directive folding fixed
  • Bullet list item wrapping fixed
  • Footnote reference should end with _

Refactoring

  • Replaced different header methods with generic template
  • Drop unused wrap parameter
  • Reusing existing code for hyperlink formatting
  • Variables names refactoring
  • Drop unused BaseTestCase class
  • Drop unused Table class
  • YAML table translator removed

Testing

  • Basic tests of RstCloth.table method added
rstcloth - Alter print methods to use __str__

Published by github-actions[bot] over 2 years ago

Contents (#25)

New features

  • Increment version for new str methods

Uncategorised!

  • replace print_content and print_table methods with str
  • fix table str
  • Merge pull request #16 from sp1thas/fix/replace-print-content-with-str-method
rstcloth - Refactoring with style

Published by thclark about 4 years ago

Refactored redundant parts of the library and styled the remainder of the code.

rstcloth - Update of build systems and maintenance catchup

Published by thclark about 4 years ago

Versions up to 0.2.6 were maintained by @tychoish and had entered an unmaintained state.

With this version, @thclark took over project, merged outstanding PRs from over the years, tidied up, sorted docs and devops, made tox
tests run and applied code style throughout.

Begun work of removing Python 2 code.

Still unstable. Pin your versions, people! Versions > 0.9 will adopt proper semver practice.

Package Rankings
Top 6.17% on Pypi.org
Badges
Extracted from project README
codecov PyPI version pre-commit black Documentation Status
Related Projects