Inline Math doesn't seem to support escapes with backslash
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
When using the inline Math syntax :math:, it doesn't seem to be possible to escape curly brackets or underscores with a backslash.
Steps to reproduce the behavior:
- Create a file that contains the following code:
''':math:`\{x \\in R\_index \}`'''
- Run the following command:
pdoc file_directory --output-dir output_directory --math
System Information
pdoc: 12.1.0
Python: 3.9.12
Platform: Windows-10-10.0.19044-SP0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue with the provided Python docstring and the pdoc file_directory --output-dir output_directory --math command. Trace the inline :math: parsing behavior and verify that escaped curly brackets and underscores are preserved correctly in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100