alamb opened a new issue, #14557: URL: https://github.com/apache/datafusion/issues/14557
### Is your feature request related to a problem or challenge? Part of https://github.com/apache/datafusion/issues/7013 @ugoa has updated our examples in the following PR to all compile and be tested - https://github.com/apache/datafusion/pull/14544, > One major problem I have with using # to hide setup code, is that the sphinx won't respect the leading # and still renders the whole block, which leading huge chunk of ugly code blocks.  ### Describe the solution you'd like I would like to be able to hide the setup code for the examples, following the rustdoc convention of ignoring lines that begin with `# ` For example, in our docs here: https://github.com/apache/datafusion/blob/91c0975c8a1382dff97474bfc45e504bc62ef016/datafusion/core/src/lib.rs#L59-L94 Lines that start with `#` are not rendered in the markdown docs on https://docs.rs/datafusion/latest/datafusion/index.html  ### Describe alternatives you've considered I wonder if we can find find some way to add a sphinx plugin or something to avoid rendering the blocks of ugly code. You can build and test the documentation locally by following the instructions here: https://github.com/apache/datafusion/blob/main/docs/README.md I normally do ```shell cd docs ./build.sh open build/html/index.html ``` ### Additional context _No response_ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
