Convert summary_overview.html to summary_overview.md once the file is ready
#414
Assignees
Labels
api: bigquery
Issues related to the googleapis/python-bigquery-dataframes API.
priority: p2
Moderately-important priority. Fix may not be included in next release.
type: docs
Improvement to the documentation for an API.
Comments
dandhlee
added
priority: p2
product-auto-label
bot
added
the
api: bigquery
gcf-merge-on-green bot
pushed a commit
that referenced
this issue
Mar 6, 2024
When the files aren't present, docfx does not convert the files from `.yml` extension to `.html`. I've tested this locally to ensure docfx keeps the file extension to `.html` as needed, which we'll need for the new files added for summary pages. The only entry that should change in the future would be `summary_overview.html` to `summary_overview.md`. Filed #414 to keep track of that. 🦕
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I'll be hard coding https://github.com/googleapis/python-bigquery-dataframes/blob/main/docs/templates/toc.yml#L7 to
summary_overview.htmlas docfx tends to keep the file extension and does not convert them to what we want them to. While keeping it assummary_overview.htmlwill continue to work, when the file is added we should rename the toc entry tosummary_overview.mdto ensure they're linked properly.The text was updated successfully, but these errors were encountered: