Skip to content

Commit

Permalink
docs(sphinx,readthedocs): introduce
Browse files Browse the repository at this point in the history
helmut-hoffer-von-ankershoffen committed Jan 2, 2025
1 parent f08fc7e commit d051f8a
Showing 4 changed files with 33 additions and 18 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ Brave Search Python Client supporting Web, Image, News and Video search.

## Usage Examples

## Streamlit App
### Streamlit App

![Watch it](https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/raw/7f2a3a2e306c81c3487c0b0eda067f0440ec3f36/examples/streamlit.gif)

@@ -270,7 +270,7 @@ TK

## Contributing

Please read our [Contributing Guidelines](CONTRIBUTING.md) for how to setup your development environment, and guidance for making pull requests.
Please read our [Contributing Guidelines](https://brave-search-python-client.readthedocs.io/en/latest/contributing.html) for how to setup your development environment, and guidance for making pull requests.

## Resources

2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -34,5 +34,5 @@
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "sphinx_rtd_theme"
html_theme = "furo"
html_static_path = ["_static"]
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -99,7 +99,7 @@ dev = [
"sphinx-copybutton==0.5.2",
"sphinx-autobuild>=2024.10.3",
"sphinx-mdinclude>=0.6.2",
"sphinx-rtd-dark-mode>=1.3.0",
"furo>=2024.8.6",
]

[tool.ruff]
43 changes: 29 additions & 14 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d051f8a

Please sign in to comment.