Skip to content

Add docs#23

Merged
hdrake merged 22 commits intomainfrom
add-docs
Feb 21, 2026
Merged

Add docs#23
hdrake merged 22 commits intomainfrom
add-docs

Conversation

@hdrake
Copy link
Owner

@hdrake hdrake commented Feb 20, 2026

This pull request introduces configuration improvements to support building documentation with Sphinx and Read the Docs. The main changes are the addition of a .readthedocs.yaml configuration file and updating the documentation dependencies.

Documentation build configuration:

  • Added a .readthedocs.yaml file to configure Read the Docs, specifying the OS, Python version, Sphinx build settings, and dependency installation methods.

Documentation dependencies:

  • Added sphinx to the docs/environment.yml dependencies to ensure Sphinx is available for documentation builds.

@hdrake
Copy link
Owner Author

hdrake commented Feb 20, 2026

@anthony-meza and @NelsonPoumaere, I drafted lightweight docs with just an installation page and the tutorial notebook. You can view the latest build here:

https://xbudget--23.org.readthedocs.build/en/23/

I'll update the homepage later today. Anything we should add?

@NelsonPoumaere
Copy link

That looks great @hdrake, and I don't see anything to add at the moment.

@hdrake hdrake merged commit b9b45ee into main Feb 21, 2026
4 checks passed
@hdrake hdrake deleted the add-docs branch February 21, 2026 04:33
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