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

Feature Request: Support for Sphinx Codeblocks #188

Open
zachcp opened this issue Jun 13, 2023 · 2 comments
Open

Feature Request: Support for Sphinx Codeblocks #188

zachcp opened this issue Jun 13, 2023 · 2 comments

Comments

@zachcp
Copy link

zachcp commented Jun 13, 2023

Hi,

This is a wonderful library. I'm hoping to use quarto in place of sphinx for some internal libraries but need to be able to build the current libraries without changing them. One of commonly used patterns that doesn't seem to be supported yet is to put example uses in our docstrings within a ..code:: block. Right now (quartodoc==0.3.3) the codeblock is not recognized as special text. Having out of the box support for this would be very helpful. Thank you.

class MyClass:
    """This is a great class

    Examples
    ========

    ..code:: python

        example_code = "here"


    """
@machow
Copy link
Owner

machow commented Jun 23, 2023

Hey, sorry for the wait. This is very doable right now! I'll add some documentation on how people can customize rendering, in order to convert codeblocks and other directives to markdown for quarto. (Then can tweak to make sure it hits your use case).

@zachcp
Copy link
Author

zachcp commented Jun 24, 2023

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants