Add Sphinx documentation for ReadTheDocs hosting#57
Merged
aidancrilly merged 2 commits intomasterfrom Feb 27, 2026
Merged
Conversation
Co-authored-by: aidancrilly <20111148+aidancrilly@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for package hosting on ReadTheDocs
Add Sphinx documentation for ReadTheDocs hosting
Feb 27, 2026
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.
NeSST had no formal documentation beyond the README and an example notebook. This adds a full Sphinx docs site suitable for hosting on ReadTheDocs.
Structure
docs/conf.py— Sphinx config:sphinx-rtd-theme,autodoc+napoleon(Google docstrings),intersphinx,myst-parser,nbsphinxdocs/index.rst— Top-level TOCdocs/installation.rst— PyPI and source install instructionsdocs/guide.rst— User guide with worked examples covering primary spectra, scattered spectra, transmission, fitting, nToF, and materialsdocs/api.rst— Auto-generated API reference for all 8 modules viaautodocdocs/example_notebook.rst— Links to the existing nbviewer-hosted Jupyter guidedocs/requirements.txt— Docs build dependenciesReadTheDocs integration
.readthedocs.yaml— v2 config; Ubuntu 22.04, Python 3.11, installs package + docs deps, points todocs/conf.pypyproject.toml— Addsdocsextras group (pip install NeSST[docs]).gitignore— Excludesdocs/_build/To enable: import the repo on readthedocs.org —
.readthedocs.yamlis auto-detected.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)numpy.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
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.