Sphinx-readme

Latest version: v1.2.1

Safety actively analyzes 682334 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 3

1.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_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**: https://github.com/TDKorn/sphinx-readme/compare/v1.2.0...v1.2.1

1.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_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**: https://github.com/TDKorn/sphinx-readme/compare/v1.1.2...v1.2.0

1.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 with `src/pkg` structure

Issues Closed

* 11

***


**Full Changelog**: https://github.com/TDKorn/sphinx-readme/compare/v1.1.1...v1.1.2

1.1.1

Bug fixes

**Full Changelog**: https://github.com/TDKorn/sphinx-readme/compare/v1.1.0...v1.1.1

1.1.0

Changes

* Add full support for toctrees

Issues Closed

* 4


**Full Changelog**: https://github.com/TDKorn/sphinx-readme/compare/v1.0.0...v1.1.0

1.0.0

Changes

* Add full support for [`intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) (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`](https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html) cross-references
* Replace external `:attr:` cross-references with links to HTML documentation

Issues Closed

* 2
* 3

***

**Full Changelog**: https://github.com/TDKorn/sphinx-readme/compare/v0.2.5...v1.0.0

Page 1 of 3

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.