Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for headings to organize functions into sections #422

Open
AlexAtCCRI opened this issue May 5, 2023 · 1 comment
Open

Support for headings to organize functions into sections #422

AlexAtCCRI opened this issue May 5, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@AlexAtCCRI
Copy link

AlexAtCCRI commented May 5, 2023

firstly, this program is awesome. thank you.

this may be asking too much from pdoc3, but in my code i usually have comment sections which are like markdown headings to organize the functions. kind of like a module-level doc-string. is there anyway to implement this with pdoc? i dont want to explicitly write a list of functions like i have to do with sphinx, because thats annoying, and easy to forget some.

example use case is a simple project with little more than a __init__.py. but with many functions it is nice to have headings to organise them. thoughts?

@kernc
Copy link
Member

kernc commented Nov 26, 2024

thoughts?

You can use --config sort_identifiers=False or similar to keep your customized order.

Other than that, I suggest writing an introductory section with desired listings in the module docstring.

@kernc kernc added the enhancement New feature or request label Nov 26, 2024
@kernc kernc changed the title feature request: support for headings to organize functions Support for headings to organize functions into sections Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants