diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0ce9313..691fce7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,9 +6,9 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-24.04 tools: - python: "3.10" + python: "3.12" python: install: @@ -16,3 +16,15 @@ python: - requirements: requirements.txt - method: pip path: . + +search: + ranking: + _sources/*: -10 + _modules/*: -5 + genindex.html: -9 + + ignore: + - 404.html + - search.html + - index.html + - 'examples/*' diff --git a/docs/conf.py b/docs/conf.py index ba89cb1..8945cef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,6 @@ "sphinx_design", "sphinxcontrib.bibtex", "sphinx_codeautolink", - "sphinx_remove_toctrees", ] # List of patterns, relative to source directory, that match files and @@ -73,6 +72,7 @@ html_theme = "pymc_sphinx_theme" html_theme_options = { "secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink", "donate"], + "search_bar_text": "Search within PyMC-BART...", "navbar_start": ["navbar-logo"], "icon_links": [ { @@ -80,17 +80,6 @@ "icon": "fa-brands fa-github", "name": "GitHub", }, - { - "url": "https://twitter.com/pymc_devs/", - "icon": "fa-brands fa-twitter", - "name": "Twitter", - }, - { - "url": "https://www.youtube.com/c/PyMCDevelopers", - "icon": "fa-brands fa-youtube", - "name": "YouTube", - }, - {"url": "https://discourse.pymc.io", "icon": "fa-brands fa-discourse", "name": "Discourse"}, ], } @@ -144,23 +133,6 @@ nb_execution_mode = "off" -remove_from_toctrees = [ - "BART/*", - "case_studies/*", - "causal_inference/*", - "diagnostics_and_criticism/*", - "gaussian_processes/*", - "generalized_linear_models/*", - "mixture_models/*", - "ode_models/*", - "howto/*", - "samplers/*", - "splines/*", - "survival_analysis/*", - "time_series/*", - "variational_inference/*", -] - # bibtex config bibtex_bibfiles = ["references.bib"] bibtex_default_style = "unsrt" diff --git a/requirements-docs.txt b/requirements-docs.txt index 5074a06..214c399 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,8 +1,6 @@ myst-nb -sphinx==5.0.2 # see https://github.com/pymc-devs/pymc-examples/issues/409 -git+https://github.com/pymc-devs/pymc-sphinx-theme +sphinx +pymc-sphinx-theme>=0.16 sphinxcontrib-bibtex -nbsphinx sphinx_design sphinx_codeautolink -sphinx_remove_toctrees