Skip to content

Conversation

@bryanjp05
Copy link
Contributor

Summary of changes

This PR is to set up automated documentation with sphinx and deploy it using gh-pages as described in issues #6 and #8. In order to allow gh-pages to properly run, I believe the admin may need to go to https://github.com/arfc/ghastly/settings/pages and set the following:
source: deploy from a branch
branch: gh-pages
folder: / (root)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • [x ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • [x ] I have read the CONTRIBUTING document.
  • [x ] My code follows the code style of this project.
  • [x ] My change requires a change to the documentation.
  • [x ] I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • [x ] All new and existing tests passed.

Associated Issues and PRs

Associated Developers

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

@bryanjp05 bryanjp05 requested a review from ZoeRichter May 6, 2025 07:26
@bryanjp05 bryanjp05 self-assigned this May 6, 2025
@bryanjp05 bryanjp05 added Difficulty:2-Challenging This issue may be complex or require specialized skills. Priority:2-Normal This work is important and should be completed ASAP. Type:Docs Is related to API documentation, website content, etc. labels May 6, 2025
@katyhuff katyhuff added this to the Establish Code Structure milestone Aug 14, 2025
@katyhuff katyhuff mentioned this pull request Aug 15, 2025
9 tasks
@ZoeRichter
Copy link
Collaborator

I am planning on reviewing/updating this PR after #37 is pulled

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Difficulty:2-Challenging This issue may be complex or require specialized skills. Priority:2-Normal This work is important and should be completed ASAP. Type:Docs Is related to API documentation, website content, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants