search

vemel / handsdown

Python documentation generator for lazy perfectionists
https://vemel.github.io/handsdown/
MIT License
85 stars 8 forks source link

Module docstrings are not included in the documentation #36

Open fhoussiau opened 4 months ago

fhoussiau commented 4 months ago

Describe the bug The text included in the """docstring""" at the top of a module is not "rendered" in the Markdown. For instance, the main example starts as:

"""
This is a module docstring. It will appear in documentation.

## Notes

You can use Markdown here to make it nicer. Also, in any docstring you
can put a global object import string in backticks, like `other_module.OtherClass`,
and it will be transformed to a link.
"""

but the output ignores this text:

# Main Example

[Handsdown API Index](../README.md#handsdown-api-index) / [Examples](./index.md#examples) / Main Example

> Auto-generated documentation for [examples.main_example](https://github.com/vemel/handsdown/blob/main/examples/main_example.py) module.

This doesn't seem to be the intended behaviour, given the example.

To Reproduce I've had this issue with every file. See all examples.

Expected behavior The module docstring included.

Desktop (please complete the following information):

vemel commented 4 months ago

Hello. THank you for the report. THis is definitely a bug, I will check.

fhoussiau commented 3 months ago

Hello, many thanks for your answer! Have you had time to look into the issue?