Skip to content

Add Sphinx documentation for ReadTheDocs hosting#57

Merged
aidancrilly merged 2 commits intomasterfrom
copilot/create-documentation-for-package
Feb 27, 2026
Merged

Add Sphinx documentation for ReadTheDocs hosting#57
aidancrilly merged 2 commits intomasterfrom
copilot/create-documentation-for-package

Conversation

Copy link
Contributor

Copilot AI commented Feb 27, 2026

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, nbsphinx
  • docs/index.rst — Top-level TOC
  • docs/installation.rst — PyPI and source install instructions
  • docs/guide.rst — User guide with worked examples covering primary spectra, scattered spectra, transmission, fitting, nToF, and materials
  • docs/api.rst — Auto-generated API reference for all 8 modules via autodoc
  • docs/example_notebook.rst — Links to the existing nbviewer-hosted Jupyter guide
  • docs/requirements.txt — Docs build dependencies

ReadTheDocs integration

  • .readthedocs.yaml — v2 config; Ubuntu 22.04, Python 3.11, installs package + docs deps, points to docs/conf.py
  • pyproject.toml — Adds docs extras group (pip install NeSST[docs])
  • .gitignore — Excludes docs/_build/

To enable: import the repo on readthedocs.org — .readthedocs.yaml is 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
    • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build (dns block)
  • docs.scipy.org
    • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html . _build (dns block)
  • numpy.org
    • Triggering command: /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

Based on the example notebook, readme and docstrings, can you create documentation for this package to be hosted on a readthedocs?


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

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
@aidancrilly aidancrilly marked this pull request as ready for review February 27, 2026 19:40
@aidancrilly aidancrilly merged commit 0b3b299 into master Feb 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants