Skip to content
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

DOCS: Setup infrastructure for documentation #1

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

rahulporuri
Copy link
Collaborator

This PR

  • creates mkdocs docs
  • includes material and glightbox addons/extensions to mkdocs in the mkdocs config
  • adds the scaffolding for the documentation
  • ignores the built docs from the git repo
  • adds a github workflow to build and push docs to gh-pages branch

This PR can be merged as-is and the filling out the individual docs pages can happen in a separate PR

This commit
- creates mkdocs docs
- includes material and glightbox addons/extensions to mkdocs
  in the mkdocs config
- adds the scaffolding for the documentation
- ignores the built docs from the git repo
- adds a github workflow to build and push docs to gh-pages branch
@rahulporuri
Copy link
Collaborator Author

@harshtandiya please note that if you want to see github pages docs via this repository, you will have to adjust a few options in the Settings tab - specifically, you will have to navigate to the Pages tab, enable github pages, and choose gh-pages as the branch from where the pages will be served.

happy to jump on a short call to clarify this

@rahulporuri
Copy link
Collaborator Author

not sure why the ci job failed - restarted it to see if it was an intermittent failure

@harshtandiya
Copy link
Owner

CI failing is my fault, fixing the tests

@harshtandiya
Copy link
Owner

@rahulporuri just making sure, this branch is supposed to be merged in develop right? are we supposed to create a branch gh-pages ?

@rahulporuri
Copy link
Collaborator Author

@rahulporuri just making sure, this branch is supposed to be merged in develop right?

yes

are we supposed to create a branch gh-pages ?

nope. that should get autocreated.

@harshtandiya harshtandiya merged commit 2989bb6 into harshtandiya:develop Oct 22, 2024
1 check failed
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