pdoc3 / pdoc3/pdoc

Include html containing javascript

Open
#423 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.2k
Forks
146
PR merge metrics
No merged PRs in 30d

Description

When I include an html file containing some Javascript using .. include:: it does not get rendered in the documentation. You can find an html file to reproduce the behaviour below:

00.html.zip

  • pdoc version: 0.10.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by unpacking the attached 00.html.zip and reproducing the behavior with pdoc 0.10.0 using the documented .. include:: directive. Trace how the included HTML and JavaScript are processed during documentation generation; done means the included HTML containing JavaScript is rendered in the generated documentation without breaking the surrounding output.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript, python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.