pdoc3 / pdoc3/pdoc

Programmatic way of showing module list

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Expected Behavior

As per #91. It's not immediately obvious how one could generate a list of modules programmatically.

It looks like your mako template changes format based on context:

<%
    module_list = 'modules' in context.keys()  # Whether we're showing module list in server mode
%>

But I'm looking for a convenient way of getting the module list to appear. Does such a method exist?

Actual Behavior

Some documentation or exposed method would be great.

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 reading issue #91 and the Mako template context shown here to understand how the module list is currently selected. Trace whether an existing programmatic entry point can expose or document this behavior; done means users have a clear documented way to generate the module list.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.