Skip to content

Update sphinx #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: canary
Choose a base branch
from
Open

Update sphinx #79

wants to merge 3 commits into from

Conversation

camillapaige
Copy link

@camillapaige camillapaige commented Mar 4, 2025

Thank you for your contribution!
To help us understand and review your changes quickly, please complete the checklist and provide all relevant details.

Brief Summary

E.g., adds navigation toggle buttons. (remove this line before submitting your PR)

Describe your PR

  • What problem does this pull request solve, or what feature does it add?
  • How is the solution implemented?
  • Any important design or architectural choices you made.

Type of Change

Please select the type of change your pull request introduces:

  • Bug fix (fixes an issue)
  • New feature (adds functionality)
  • Documentation update (improves or adds documentation)
  • Code style/refactor (improves the code structure, does not add functionality)
  • Configuration change (modifies settings or configurations)
  • Build/dependency update (changes build or dependencies)

Related Issues

Link any related issues or pull requests, e.g., #42, #12 (remove this line before submitting your PR)

Additional Notes

E.g., potential side effects, special areas to pay attention to, etc. (remove this line before submitting your PR)

Contributor Checklist

Before submitting, please confirm the following:

  • I have read the CONTRIBUTING.md guidelines.
  • I have tested my changes locally and ensured they work as expected.

Thank you!

We deeply value your efforts to contribute. Your PR will be reviewed soon, and we'll keep you posted.
If you have any questions or need assistance, feel free to reach out!

@camillapaige
Copy link
Author

Hi Akshay,

I hope you're doing well. Kytt asked me to make some changes to the Sphinx pages for SCHOOL. I edited a few things on the pages but I wanted to test updating the page with a few changes, before I continued making additional edits. Kytt said that I could edit the Sphinx pages by making a branch and merging it but when I tried to update the page, one of the checks failed. Please let me know what I can do to successfully merge my branch to the main. Thanks for your help!

Camilla

@xames3
Copy link
Collaborator

xames3 commented Mar 5, 2025

you need to first test your changes locally and then raise a PR. let me walk you through the steps:

  • fork the repository using, you can click here to do it quickly. forking will make a copy of this project in your GitHub account. this is where you can make your changes.
  • once, you've forked the repository, you can either make changes locally or online. I'd recommend doing it locally so you can build and see the changes for yourself.
  • clone the forked repository using command, git clone << forked repository url >> and change into that directory using cd command (cd TOPSTSCHOOL-SPHINX). this is your local copy of the project.
  • make and checkout into your branch using git checkout -b << your branch name >>
  • make edits, commit and push to your remote copy.
  • once everything mentioned above is done, you can open the PR. If everything is correct, the PR will automatically evaluate and pass the test cases.

hope this helps. feel free to reach out if you need any more clarification.

@xames3
Copy link
Collaborator

xames3 commented Mar 11, 2025

@camillapaige, are there any challenges?

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.

2 participants