Skip to content

Releases: TDKorn/sphinx-readme

v1.2.1

05 Feb 03:00

Choose a tag to compare

Changes

  • Add support for :exc: cross-references
  • Handle non-existent source files
  • Add option to specify names of output files in the readme_src_files confval
  • Add readthedocs for test package
  • Add tests for admonitions and toctrees

Bug Fixes

  • Fix bug where nested admonitions don't render properly when being replacing with list-table directives
  • Fix bug where generic admonitions that are nested in specific admonitions weren't being replaced properly
  • Fix bug where replacement of cross-references in std/rst domain could lead to a duplicate label
  • Fix recursion error when nested toctrees contain a self entry

Full Changelog: v1.2.0...v1.2.1

v1.2.0

22 Jan 03:23

Choose a tag to compare

Changes

  • Add full support for substitution definitions that contain cross-references
  • Improve support for cross-references to RST and Standard domain by forcing replacement with substitutions
  • Replace any unresolvable cross-references with an inline literal, in all domains
  • Add linkcode links for properties and cached properties
  • Include rst_prolog and rst_epilog in generated files
  • Sort header values alphabetically, regardless of capitalization
  • Add parser tests

Bug Fixes

  • Fix bug when replacing rubric directives with sections inside of list-table admonitions

Full Changelog: v1.1.2...v1.2.0

v1.1.2

14 Dec 08:33

Choose a tag to compare

Changes

  • Replace all unresolved Python domain cross-references with inline literals, instead of just replacing attributes
  • Replace cross-references with inline literals in titles (fixes bug with toctrees)
  • Fix bugs in linkcode_resolve() - now compatible with unpublished packages, decorated functions, and repos with src/pkg structure

Issues Closed


Full Changelog: v1.1.1...v1.1.2

v1.1.1

10 Dec 03:36

Choose a tag to compare

Bug fixes

Full Changelog: v1.1.0...v1.1.1

v1.1.0

26 Nov 08:43

Choose a tag to compare

Changes

  • Add full support for toctrees

Issues Closed

Full Changelog: v1.0.0...v1.1.0

v1.0.0

20 Nov 05:23

Choose a tag to compare

Changes

  • Add full support for intersphinx (external cross-references) and all associated cross-reference syntax (:external:, :external+pkg:, pkg:target)
  • Add full support for rst domain cross-references (:rst:role:, :rst:dir:)
  • Add support for explicit titles in py domain cross-references
  • Add support for sphinx.ext.autosectionlabel cross-references
  • Replace external :attr: cross-references with links to HTML documentation

Issues Closed


Full Changelog: v0.2.5...v1.0.0

v0.2.5

12 Nov 22:34

Choose a tag to compare

Changes

  • Replace xrefs that are preceded/followed by acceptable characters
  • Add type checking, is_valid_username(), and is_valid_repo() to git.py
  • Add unit tests for all of git.py

Full Changelog: v0.2.4...v0.2.5

v0.2.4

21 Sep 05:04

Choose a tag to compare

Changes

  • #8 Add support for self in toctrees
  • #9 - Add support for std and py xrefs with the :domain:role:`target` syntax
  • #10 - Support for explicit titles in toctrees
  • Improve replacement of all xrefs
  • Improve support for relative paths when resolving :doc: xrefs
  • Add tests for replace_attrs()

Full Changelog: v0.2.3...v0.2.4

v0.2.3

29 Aug 03:38

Choose a tag to compare

Changes

  • Fix bugs with title, attribute xref, and rubric parsing/replacement
  • Map cross-references and substitutions by source file; substitution definitions are only prepended if they are present in the file
  • Add support for relative paths in :doc: xref targets
  • Update format_rst() to preserve substitutions, custom links

Full Changelog: v0.2.2...v0.2.3

v0.2.2

29 Jul 16:29

Choose a tag to compare

* Changed csv-table admonitions to use list-table directive instead

  • Allows for nested admonitions and nested directives when the raw directive can't be used (see #1 / #6)

* Added support for multiline and nested rubric directives (see #7)


Full Changelog: v0.2.1...v0.2.2