Use ReadTheDocs theme for GitHub Pages documentation#15
Merged
Conversation
…ctions Co-authored-by: rinziv <12544167+rinziv@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Use ReadTheDocs theme for GitHub Pages documentation
Use ReadTheDocs theme for GitHub Pages documentation
Nov 26, 2025
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.
Switch documentation theme from Alabaster to
sphinx_rtd_themefor GitHub Pages and add ReadTheDocs.io deployment instructions.Changes
docs/conf.py): Sethtml_theme = "sphinx_rtd_theme"with appropriate navigation optionssphinx_rtd_themetodocs/requirements.txtand.github/workflows/docs.yml.readthedocs.yml): Updated to v2 format withbuildsection specifying Ubuntu 22.04 and Python 3.10CONTRIBUTING.rst): Added "Deploying Documentation to ReadTheDocs" section with step-by-step instructionsScreenshot
Note
Actual deployment to readthedocs.io requires a maintainer to import the project at readthedocs.org - the configuration is ready for this.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.python.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)docs.scipy.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)matplotlib.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)numpy.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)pandas.pydata.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)pyscaffold.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)scikit-learn.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)setuptools.pypa.io/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)www.sphinx-doc.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.