Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ The AUTHORS/Contributors are (and/or have been):
* Edward Ross <gh: EdwardJRoss>
* Gregory Anders <gh: gpanders>
* Alex Vandiver <gh: alexmv>
* Hugohong258 <gh: Hugohong258>

Maintainer:

Expand Down
5 changes: 5 additions & 0 deletions ChangeLog.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Unreleased
==========

* Clarify that IGNORE_ANCHORS maps to HTML2Text.ignore_links in the usage guide.

2025.4.15
=========
----
Expand Down
7 changes: 6 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ simple indications of their function.
- INLINE_LINKS for formatting images and links
- PROTECT_LINKS protect from line breaks
- GOOGLE_LIST_INDENT no of pixels to indent nested lists
- IGNORE_ANCHORS
- IGNORE_ANCHORS to omit link formatting (set `parser.ignore_links`)
- IGNORE_IMAGES
- IMAGES_AS_HTML always generate HTML tags for images; preserves `height`, `width`, `alt` if possible.
- IMAGES_TO_ALT
Expand Down Expand Up @@ -110,6 +110,11 @@ To alter any option the procedure is to create a parser with
`parser = html2text.HTML2Text()` and to set the option on the parser.
example: `parser.unicode_snob = True` to set the UNICODE_SNOB option.

The `IGNORE_ANCHORS` configuration constant is an exception to this naming
convention: set `parser.ignore_links = True`, rather than
`parser.ignore_anchors`, to keep link text without its Markdown link formatting.
This is also the Python equivalent of the `--ignore-links` command line option.


Command line options
--------------------
Expand Down