Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readthedocs: Add search ranking and use latest Python version #242

Merged
merged 9 commits into from
Apr 24, 2023
16 changes: 15 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
python: "3"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -18,6 +18,7 @@ sphinx:
# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf
- htmlzip

# Optionally declare the Python requirements required to build your docs
python:
Expand All @@ -26,3 +27,16 @@ python:
path: .
extra_requirements:
- docs

# Settings for more control over Server side search.
# https://docs.readthedocs.io/en/stable/config-file/v2.html#search
search:
# Define which files pop up higher in the search results
ranking:
'docs/source/': 3
'ema_workbench/examples/*': 2
'ema_workbench/**': 1
'**/models/*': -1

# Exclude some files from the search
ignore: ['MANIFEST.in', '.gitattributes', '**/.gitignore', '**/data/*', '.eggs/**']