mgedmin / mgedmin/restview

Using `.. contents::` causes raw CSS to show up at the top of the page when using readme-renderer >= 37.0

Open
#65 7 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
224
Forks
36
PR merge metrics
No merged PRs in 30d

Description

```rst
=====
Title
=====

.. contents:: Table of Contents
:depth: 2

Heading 1
---------
Description

Heading 2
~~~~~~~~~
Long text about this
```

Produces weird results (on top). `` and `` tags not opened/closed properly - result in a broken view.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the supplied reStructuredText example with readme-renderer >= 37.0 and inspect the rendered page around the Table of Contents. Confirm how the and tags are emitted; done when the page no longer shows raw CSS and the tags are properly opened and closed.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.