Releases: TDKorn/sphinx-readme
Releases · TDKorn/sphinx-readme
v1.2.1
Changes
- Add support for
:exc:cross-references - Handle non-existent source files
- Add option to specify names of output files in the
readme_src_filesconfval - 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-tabledirectives - 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
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_prologandrst_epilogin generated files - Sort header values alphabetically, regardless of capitalization
- Add parser tests
Bug Fixes
- Fix bug when replacing
rubricdirectives with sections inside oflist-tableadmonitions
Full Changelog: v1.1.2...v1.2.0
v1.1.2
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 withsrc/pkgstructure
Issues Closed
Full Changelog: v1.1.1...v1.1.2
v1.1.1
Bug fixes
Full Changelog: v1.1.0...v1.1.1
v1.1.0
v1.0.0
Changes
- Add full support for
intersphinx(external cross-references) and all associated cross-reference syntax (:external:,:external+pkg:,pkg:target) - Add full support for
rstdomain cross-references (:rst:role:,:rst:dir:) - Add support for explicit titles in
pydomain cross-references - Add support for
sphinx.ext.autosectionlabelcross-references - Replace external
:attr:cross-references with links to HTML documentation
Issues Closed
Full Changelog: v0.2.5...v1.0.0
v0.2.5
Changes
- Replace xrefs that are preceded/followed by acceptable characters
- Add type checking,
is_valid_username(), andis_valid_repo()togit.py - Add unit tests for all of
git.py
Full Changelog: v0.2.4...v0.2.5
v0.2.4
Changes
- #8 Add support for self in toctrees
- #9 - Add support for
stdandpyxrefs 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
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
* Changed csv-table admonitions to use list-table directive instead
- Allows for nested admonitions and nested directives when the
rawdirective can't be used (see #1 / #6)