Skip to content

[Proposal] Use great-docs package for documentation #28

Description

@adarshdigievo

Motive

  • We currently host our Python SDK documentation on Read the Docs.
  • While Read the Docs is a great platform, it has limited support for self-hosting documentation pages and features such as copying a page as Markdown.
  • Great Docs is a new open-source documentation site generator that better fits these needs.
  • Using Great Docs, we can add doc generation to GitHub actions (command: great-docs setup-github-pages), and can host the SDK documentation at serpapi.github.io/serpapi-python
  • Even though the library itself is newer (below 200 stars on GitHub), it is maintained by https://github.com/posit-dev, who already has a good portfolio of well-maintained Python packages.

Great-Docs package

Image Image Image Image

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions