How can I create a title page for a project with multiple modules?

[MaddyGuthridge]

Problem Description

One of my projects consists of multiple modules, which due to design constraints cannot be merged under one umbrella. PDoc handles this very well, with a clear list of modules being shown in the left-hand panel on the landing page. However, since there is no main __init__.py file that I can include some markdown within (refer to the "include markdown files" section of the docs), it doesn't seem like I can take any action to customise the site's landing page.

Proposal

If there is a way to do this without employing any hacks or workarounds which would mess up my project's hierarchy, then add some more clear documentation to help users find info on it.

Otherwise, add support for a command line flag that lets you specify a markdown file to be included on the landing page for documentation of projects that use many modules.

Alternatives

I can't think of any

Additional context

Lots of empty space, which could benefit from adding a nice readme file.

[mhils]

Hi there!

I think you can relatively easily accomplish what you are looking for by overriding the index.html.jinja2 template:

custom-template/index.html.jinja2:

{% extends "default/index.html.jinja2" %}

{% block content %}
    <main class="pdoc">
    Hello World!
    </main>
{% endblock %}

pdoc -t custom-template/ ...

Hope that helps! Here's a more complex example:

{% extends "default/index.html.jinja2" %}

{% block title %}Hello World{% endblock %}

{% block nav %}
    <img src="https://pdoc.dev/logo.svg" class="logo" alt="project logo"/>
    <input type="search" placeholder="Search..." role="searchbox" aria-label="search"
                   pattern=".+" required>
    {{ super() }}
{% endblock %}

{% block content %}
    <main class="pdoc">

    {% filter to_html %}
# Hello World!
This is a test page with Markdown contents.
    {% endfilter %}
    <strong>You can also write plain HTML here!</strong>

    </main>
    {% include "search.html.jinja2" %}
{% endblock %}

[MaddyGuthridge]

Cool, thanks for the explanation! Do you think it could be worthwhile updating the documentation for it to make it more clear?

[mhils]

Actually that's a fair point. :)

[vivek87799]

Hi,
First I would like to thank you for the simple and a wonderful documentation tool.

I have a similar requirement for my project. I have created a custom-template dir with index.html.jinja2 file to override

pdoc -t .\demo_poc\custom-template\ .\demo_poc\

Unfortunately nothing changes. Can you kindly help me with this.

[javiortizmol]

Hi, the steps that you suggested in the documentation didn't work