Feat/self hosted docs#36
Open
adarshdigievo wants to merge 7 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR replaces the old ReadTheDocs/Sphinx documentation setup with a static GitHub Pages site for
serpapi-python(using thegreat-docsPython package).great-docspackage for documentation #28serpapi.github.io/serpapi-pythonwhen a new version is released.When docs are built
Deployed docs are built from the release workflow on version tags matching
v**.The release flow is now:
New dependency
Adds an optional docs extra:
New docs tests
Adds doc tests. The code snippets present in docs pages are included in the pytest suite of the package via
tests/test_docs_examples.py, which executes Python fenced code blocks from:README.mddocs/index.mddocs/user_guide/*.mddocs/examples/*.mdThe test uses
SERPAPI_KEYorAPI_KEY, replaces placeholdersecret_api_keyvalues, and supports<!-- docs-test: skip ... -->for examples that should not run, such as proxy/TLS placeholder snippets.pyproject.tomlalso enables module doctests forserpapi.Removed old docs setup
Removes the ReadTheDocs/Sphinx files:
.readthedocs.yamldocs/Makefiledocs/conf.pydocs/requirements.txtdocs/index.rstdocs/_static/serpapi-python.png.gitignorenow ignores the generatedgreat-docs/output instead ofdocs/build.Docs structure overview
Adds:
great-docs.ymlfor site configuration, navigation, API reference grouping, theme settings, andllms.txtpre-render generation.docs/index.mdas the docs homepage.docs/user_guide/pages for setup, client usage, parameters, pagination, errors/timeouts, account/location helpers, migration, async archive, threading, multiprocessing, zero trace, JSON Restrictor, and request options.docs/examples/pages grouped by search engines, AI answers, local/maps, shopping, travel, finance/trends/jobs/events, media/apps/research.assets/.scripts/build_llms_txt.pyso/llms.txtincludes useful homepage/getting-started context, not only API reference links.core.pyandmodels.pyfiles are changed to match the great-docs supported format.Screenshots: