For building DataSafari's documentation with Sphinx, I have utilized the directive autofunction::, which at first presented many rendering issues rooted from the suboptimal formatting of the NumPy doc strings.
From there, an arduous process of editing and optimizing doc strings was initiated. After getting the doc strings to where they needed to be, Sphinx's autofunction:: did a great job converting the doc strings to HTML in the final docs site.
I have further enhanced each individual module docs page with various metadata using OpenGraph through the OpenGraph extension for Sphinx.
Additionally, I have added keywords for each module to improve SEO using Sphinx's directive, meta::.
Finally, I designed and created informative social cards for each subpackage using Adobe Illustrator.
The final .rst file followed this format (with unique title, description and keywords for each module; and unique social thumbnail for each subpackage):
:og:title: explore_df() - DataSafari Official Docs
:og:description: Explore a DataFrame and gain a birds-eye view of summary statistics, NAs, data types and more.
:og:image: https://www.datasafari.dev/docs/_static/thumbs/ds-branding-thumb-sub-docs-explorer.png
.. meta::
:keywords: DataSafari, DataSafari documentation, DataFrame exploration, summary statistics, data types, missing values analysis, DataFrame summary, pandas DataFrame, data analysis, data exploration, DataSafari documentation, DataFrame info, DataFrame head, DataFrame description
============
explore_df()
============
.. currentmodule:: datasafari.explorer
.. autofunction:: explore_df
For building DataSafari's documentation with Sphinx, I have utilized the directive
autofunction::, which at first presented many rendering issues rooted from the suboptimal formatting of the NumPy doc strings.From there, an arduous process of editing and optimizing doc strings was initiated. After getting the doc strings to where they needed to be, Sphinx's
autofunction::did a great job converting the doc strings to HTML in the final docs site.I have further enhanced each individual module docs page with various metadata using OpenGraph through the OpenGraph extension for Sphinx.
Additionally, I have added keywords for each module to improve SEO using Sphinx's directive,
meta::.Finally, I designed and created informative social cards for each subpackage using Adobe Illustrator.
The final
.rstfile followed this format (with unique title, description and keywords for each module; and unique social thumbnail for each subpackage):