pdoc3 / pdoc3/pdoc

Offline html output

Open
#136 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Expected Behavior

To generate an offline document, using pdoc, I found that I can generate pdf document but the pdf doc seems a little confusing. The html output is pretty but link to some online assets such as https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css, so this option is not available for a offline project. A extra option to scratch those static assets and "freeze" them in a local directory maybe very useful.

Additional info
  • pdoc version: 0.7.2

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

The issue names no files, tests, or entry points. Start by tracing the HTML output path and locating where the external normalize.css URL is emitted. Done should mean generated HTML documentation can be used offline with its static assets available locally.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.