cancel
Showing results forย 
Search instead forย 
Did you mean:ย 
Data Engineering
Join discussions on data engineering best practices, architectures, and optimization strategies within the Databricks Community. Exchange insights and solutions with fellow data engineers.
cancel
Showing results forย 
Search instead forย 
Did you mean:ย 

Pydoc / Documentation Module

Kayla
Valued Contributor

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.

1 ACCEPTED SOLUTION

Accepted Solutions

User16539034020
Contributor II

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.

View solution in original post

1 REPLY 1

User16539034020
Contributor II

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.

Connect with Databricks Users in Your Area

Join a Regional User Group to connect with local Databricks users. Events will be happening in your city, and you wonโ€™t want to miss the chance to attend and share knowledge.

If there isnโ€™t a group near you, start one and help create a community that brings people together.

Request a New Group