Skip to content

FIREFLY-1440: Set up continuous deployment for documentation website #57

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

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

jaladh-singhal
Copy link
Member

@jaladh-singhal jaladh-singhal commented Mar 27, 2024

Fixes FIREFLY-1440

  • Updated outdated sphinx docs infrastructure (Makefile, conf.py, etc.) using general Sphinx setup (over LSST specific one)
  • Restructured docs/ content to make hierarchy clear
  • Added a developer guide section in docs
  • Created a github action workflow to build and deploy docs to github pages each time a commit is pushed to master

Testing

Checkout this branch locally. Update/create environment with the requirements.txt and make sure to install firefly_client. Follow the steps in docs/development/guide.rst to build and check the documentation.

Note: We will be able to test workflow and see the github pages at https://caltech-ipac.github.io/firefly_client/ only after this PR is merged. Which means this may require few iterations and/or direct pushes

@jaladh-singhal jaladh-singhal requested a review from robyww March 27, 2024 02:02
@jaladh-singhal jaladh-singhal self-assigned this Mar 27, 2024
@jaladh-singhal jaladh-singhal force-pushed the FIREFLY-1440-cd-gh-action branch from da69d04 to 89f356c Compare March 28, 2024 01:49
@jaladh-singhal jaladh-singhal merged commit 4428b5c into master Mar 28, 2024
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