Skip to content

Adding read the docs config#40

Merged
jimc101 merged 5 commits into
mainfrom
39-read-the-docs
Jun 27, 2026
Merged

Adding read the docs config#40
jimc101 merged 5 commits into
mainfrom
39-read-the-docs

Conversation

@wathen

@wathen wathen commented Jun 25, 2026

Copy link
Copy Markdown
Member

Summary

Briefly describe what this pull request changes.

  • Adds skeleton read the docs template to be filled out
  • Adds automated tests for documentation
  • Adds API

Check the build works fine and cookbooks are all set up correctly


Related issue

Closes #39


Type of change

Select all that apply:

  • Bug fix
  • New feature
  • Code port
  • Refactor
  • Documentation update
  • Test update
  • Build / CI change
  • Other: <describe>

@wathen wathen marked this pull request as ready for review June 25, 2026 13:05
@wathen wathen requested a review from jimc101 June 25, 2026 13:05
@jimc101

jimc101 commented Jun 27, 2026

Copy link
Copy Markdown
Member

The docs built out of the box once I installed the package and docs dependencies. There are a lot of warnings displayed as the docs are built, and the docs clearly need work to make them publishable. However, these problems could be addressed in a separate issue or issues. These changes appear to achieve what was intended - create a template readthedocs config that can be used to build the docs.

@jimc101 jimc101 closed this Jun 27, 2026
@jimc101 jimc101 reopened this Jun 27, 2026

@jimc101 jimc101 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The docs built out of the box once I installed the package and docs dependencies. There are a lot of warnings displayed as the docs are built, and the docs clearly need work to make them publishable. However, these problems could be addressed in a separate issue or issues. These changes appear to achieve what was intended - create a template readthedocs config that can be used to build the docs.

@jimc101 jimc101 merged commit ce3ac13 into main Jun 27, 2026
10 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.

Read the docs documentation

2 participants