- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
05-17-2023 07:43 AM
Does anyone have a recommendation for something along the lines of Pydoc that can be used to aggregate docstrings and the like into documentation pages?
I tried Pydoc and it failed because of the magic commands in my repo.
- Labels:
-
Magic Commands
Accepted Solutions
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
06-06-2023 09:49 AM
Sphinx could be an option here. It parses and render Databricks notebooks in the documentation. You might want to look into it to see if it fits your needs. However, it may not handle magic commands very well, and it assumes your notebooks are exported in .dbc format.
If your Databricks notebooks are heavily reliant on magic commands, this could not work well. In this case, you might need to consider creating a separate documentation process that doesn't rely on extracting docstrings from your notebooks.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
06-06-2023 09:49 AM
Sphinx could be an option here. It parses and render Databricks notebooks in the documentation. You might want to look into it to see if it fits your needs. However, it may not handle magic commands very well, and it assumes your notebooks are exported in .dbc format.
If your Databricks notebooks are heavily reliant on magic commands, this could not work well. In this case, you might need to consider creating a separate documentation process that doesn't rely on extracting docstrings from your notebooks.

