Initalize package documentation - #11
Merged
Merged
Conversation
This is for two purposes: (1) to say what the directory is for, and (2) to keep this directory in version control so that we can avoid Sphinx build errors in CI. 😅️
namurphy
commented
Sep 2, 2026
Member
Author
There was a problem hiding this comment.
My main motivation for adding this file is so that the directory shows up when docs are built in CI, and git only tracks files, not directories...
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.
Description
Added the framework for building documentation with Sphinx, with the markup syntax set to reStructuredText by default.
Documentation can now be built with
nox -s docsin the top-level directory of the repository.Motivation
Details
After installing
sphinx, I ransphinx-quickstartand followed the prompts.I also added the
docssession tonoxfile.py. The documentation can now be built by runningnox -s docsin the top-level directory of the repository.Future work