Can't render reST directives

timothycrosley / pdocs

A simple program and library to auto generate API documentation for Python modules.

Other

76 stars 20 forks source link

Can't render reST directives #40

Open labrunhosarodrigues opened 1 year ago

labrunhosarodrigues commented 1 year ago

I am currently unable to get PDOCs to render .. math:: blocks and citations ([label]_ .. [label] citation) which should be part of numpy-doc style.

Is there any configuration I should add, or is this something pdocs should support by default?

labrunhosarodrigues commented 1 year ago

For the math part I added polyfill and mathjax as extra_javascript as mkdocs configuration:

[tool.portray.mkdocs]
extra_javascript = [
    "https://polyfill.io/v3/polyfill.min.js?features=es6",
    "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
]

And switched to $$ ... $$ syntax.