Initial ReadTheDocs Setup#443
Open
lukelowry wants to merge 3 commits into
Open
Conversation
6dd55a4 to
b02a2c8
Compare
shakedregev
reviewed
Jun 9, 2026
|
|
||
| ## Sections | ||
|
|
||
| - [CommonMath](generated/common-math.md) |
Collaborator
There was a problem hiding this comment.
It's not clear to me where this is pulling from. Why is the Heaviside function defined as $\sigma(x)$? This is confusing.
Collaborator
Author
There was a problem hiding this comment.
It is the logistic function. This symbol is used for it, so I use it also for the scale at infinity (which is also the Heaviside function).
b02a2c8 to
79f578c
Compare
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
Adds initial Read the Docs support for GridKit documentation.
The live proof of concept is here: https://gridkit.readthedocs.io/en/latest/
I tested this on a fork because I do not have permissions to connect RTD to this repository. I will release the RTD project/domain name once this is merged.
Proposed changes
.readthedocs.yaml, Sphinx config, and docs requirements.Checklist
-Wall -Wpedantic -Wconversion -Wextra. N/A, docs-only.Further comments
Setting up on the RTD side takes less than 30 seconds.
Typically, the model documentation READMEs would be in docs/ and readthedocs expects that so we have a temporary script that pulls those into docs/ as a pre-build task for RTD