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

Sync build docs workflow with TARDIS #235

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

atharva-2001
Copy link
Member

📝 Description

Type: 🪲 bugfix | 🚀 feature | ☣️ breaking change | 🚦 testing | 📝 documentation | 🎢 infrastructure

Syncs Docs workflow with TARDIS

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@atharva-2001 atharva-2001 added the documentation Improvements or additions to documentation label Dec 5, 2024
run: |
pip install git+https://github.com/tardis-sn/[email protected]

- name: Install STARDIS
id: install-stardis
# shell: bash -l {0}
run: |
pip install -e .[docs]

- name: Make Sphinx HTML
id: make-sphinx-html
run: |
make -C docs html

Choose a reason for hiding this comment

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

I think we should also change this command with the one in tardis


if [[ $BRANCH == $DEFAULT ]]; then
echo "DEST_DIR=" >> $GITHUB_ENV
- name: Set destination directory

Choose a reason for hiding this comment

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

Indentation needs to be fixed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: waiting for review
Development

Successfully merging this pull request may close these issues.

3 participants