cancel
Showing results forย 
Search instead forย 
Did you mean:ย 
Data Engineering
cancel
Showing results forย 
Search instead forย 
Did you mean:ย 

Pydoc / Documentation Module

Kayla
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
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
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.

Welcome to Databricks Community: Lets learn, network and celebrate together

Join our fast-growing data practitioner and expert community of 80K+ members, ready to discover, help and collaborate together while making meaningful connections. 

Click here to register and join today! 

Engage in exciting technical discussions, join a group with your peers and meet our Featured Members.