Skip to content

Initial ReadTheDocs Setup#443

Open
lukelowry wants to merge 3 commits into
developfrom
lukel/readthedocs-dev
Open

Initial ReadTheDocs Setup#443
lukelowry wants to merge 3 commits into
developfrom
lukel/readthedocs-dev

Conversation

@lukelowry

@lukelowry lukelowry commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

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

  • Add .readthedocs.yaml, Sphinx config, and docs requirements.
  • Generate RTD pages from existing README files instead of duplicating them.
  • Structure RTD into Installation, Applications, Models, Examples, API Reference, and Development.

Checklist

  • All tests pass for the focused coverage listed below.
  • Code compiles cleanly with flags -Wall -Wpedantic -Wconversion -Wextra. N/A, docs-only.
  • The new code follows GridKit™ style guidelines.
  • N/A There are unit tests for the new code. n/a docs-only.
  • The new code is documented.
  • The feature branch is rebased with respect to the target branch.
  • I have updated CHANGELOG.md to reflect the changes in this PR.

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

@lukelowry lukelowry requested a review from pelesh June 8, 2026 05:38
@lukelowry lukelowry self-assigned this Jun 8, 2026
@lukelowry lukelowry added the documentation Improvements or additions to documentation label Jun 8, 2026
@lukelowry lukelowry force-pushed the lukel/readthedocs-dev branch from 6dd55a4 to b02a2c8 Compare June 8, 2026 17:47
Comment thread docs/models/index.md

## Sections

- [CommonMath](generated/common-math.md)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear to me where this is pulling from. Why is the Heaviside function defined as $\sigma(x)$? This is confusing.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@lukelowry lukelowry force-pushed the lukel/readthedocs-dev branch from b02a2c8 to 79f578c Compare June 10, 2026 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants