Replies: 3 comments 7 replies
|
Why is griffe2md not answering your use-case? |
|
I guess you could write a short script that looks for placeholders in a markdown file and replaces them with the output of griffe2md. |
|
I tried, but it doesn't work as expected. I'm looking to solve the problem for a very specific use case ::: statsforecast.models.AutoARIMA
handler: python
options:
heading_level: 3
members:
- fit
- predict
- predict_in_sample
- forecast
- forward
show_root_heading: true
show_source: trueI'm trying to write the equivalent python code for the above config which would generate the rendered html/md content. Ideally I'd like to extract the content in md format. I tried converting html to md, but it gets very noisy |
|
Please share your docstring 🙂 |
|
Thanks, can you please report these two bugs in new issues? Just paste the input (docstring) and buggy output there. |
|
Will do, I'll tag you in the issues! Thanks for the prompt response! |
|
I've created the issue, hopefully you'll be able to help in a better way 😅 |
Uh oh!
There was an error while loading. Please reload this page.
Hello, Thanks for this great extension! It is quite handy to have the extension scrape docstrings from an entire py file just with the help of
::: foo.moo, but is there a way to the content in md format which we actually see on the frontend?Something like a command that can be run in CLI
mkdocs generate md?, and then you get a scraped md file. I know theregriffe2mdbut it isn't what I'm looking forThanks in advance!
All reactions