yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-12-30 08:37:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Add support for hierarchical docs (#5278)

Browse Source 
Co-authored-by: bogdankostic <bogdankostic@web.de>
This commit is contained in:
Silvano Cerza 2023-07-07 17:00:29 +02:00 committed by GitHub
parent 9acb275680
commit d6f855cbc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/pydoc/renderers.py
View File

@ -18,6 +18,7 @@ title: {title}
excerpt: {excerpt}
category: {category}
slug: {slug}
parentDocSlug: {parent_doc_slug}
order: {order}
hidden: false
---
@ -39,6 +40,7 @@ class ReadmeRenderer(Renderer):
excerpt: str
slug: str
order: int
parent_doc_slug: str = ""
# Docs categories fetched from Readme.io
categories: t.Dict[str, str] = dataclasses.field(init=False)
# This exposes a special `markdown` settings value that can be used to pass
@ -95,6 +97,7 @@ class ReadmeRenderer(Renderer):
return README_FRONTMATTER.format(
title=self.title,
category=self.categories[self.category_slug],
parent_doc_slug=self.parent_doc_slug,
excerpt=self.excerpt,
slug=self.slug,
order=self.order,