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

Remove indentation in text template for markdown files #434

Open
pdashk opened this issue Dec 19, 2023 · 0 comments
Open

Remove indentation in text template for markdown files #434

pdashk opened this issue Dec 19, 2023 · 0 comments

Comments

@pdashk
Copy link

pdashk commented Dec 19, 2023

Expected Behavior

Output of pdoc.Module().text() generates a markdown file where the headings are not indented. Indentation in markdown creates block quotes, which is not the intended purpose the the h3 (###) headings.

Example output:

`Structure(*args, **kwargs)`
:   Common class for all structures.

### Ancestors (in MRO)

* core.StructuredNode
* core.NodeBase
* properties.PropertyManager

Actual Behavior

text.mako template has indentations for these sections, such that output is:

Example output:

`Structure(*args, **kwargs)`
:   Common class for all structures.

    ### Ancestors (in MRO)

    * core.StructuredNode
    * core.NodeBase
    * properties.PropertyManager

Steps to Reproduce

Run pdoc -o in command line without --html flag to create `.md files.

Additional info

  • pdoc version: 0.10.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant