[Bug 1900129] New: Review Request: python-sphinx_selective_exclude -
Sphinx eager ".. only::" directive and other selective rendition extensions
by bugzilla@redhat.com
https://bugzilla.redhat.com/show_bug.cgi?id=1900129
Bug ID: 1900129
Summary: Review Request: python-sphinx_selective_exclude -
Sphinx eager ".. only::" directive and other selective
rendition extensions
Product: Fedora
Version: rawhide
Hardware: All
OS: Linux
Status: NEW
Component: Package Review
Severity: medium
Priority: medium
Assignee: nobody(a)fedoraproject.org
Reporter: michel(a)michel-slm.name
QA Contact: extras-qa(a)fedoraproject.org
CC: package-review(a)lists.fedoraproject.org
Target Milestone: ---
Classification: Fedora
Spec URL:
https://salimma.fedorapeople.org/specs/python/python-sphinx_selective_exc...
SRPM URL:
https://salimma.fedorapeople.org/specs/python/python-sphinx_selective_exc...
Description:
The implementation of ".. only::" directive in Sphinx documentation generation
tool is known to violate principles of least user surprise and user
expectations
in general. Instead of excluding content early in the pipeline (preprocessor
style), Sphinx defers exclusion until output phase, and what's the worst,
various stages processing ignore "only" blocks and their exclusion status, so
they may leak unexpected information into ToC, indexes, etc.
This projects tries to rectify situation on users' side. It actually changes
the
way Sphinx processes "only" directive, but does this without forking the
project, and instead is made as a standard Sphinx extension, which a user may
add to their documentation config. Unlike normal extensions, extensions
provided
in this package monkey-patch Sphinx core to work in a way expected by users.
Fedora Account System Username: salimma
--
You are receiving this mail because:
You are on the CC list for the bug.
You are always notified about changes to this product and component
3 years, 4 months