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

Add DocsDocumenter action #4

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Add DocsDocumenter action #4

merged 2 commits into from
Nov 6, 2024

Conversation

penelopeysm
Copy link
Member

This PR adds a second action in which builds Documenter.jl docs, then insert the navbar before deploying.

Usage in another repo would just then be

on:
  push:
    branches: [main]

jobs:
  build-docs:
    permissions:
      contents: write
    runs-on: ubuntu-latest

    steps:
      - name: Build Documenter.jl docs
        uses: TuringLang/DocsNav/DocsDocumenter

I am pretty sure that this should work across pretty much every TuringLang repo!

@shravanngoswamii This isn't a complete PR, just a proof of principle – but if you agree with the principle of doing this, then I can:

  • rename the repo just to 'actions' (then it can become a catch-all for all the actions we want to have)
  • update the README accordingly (this pr is shockingly underdocumented 😄)

@shravanngoswamii
Copy link
Member

but if you agree with the principle of doing this

To be honest, I never thought of doing it this way😅, but it's a great idea! This will help us maintain consistency in building docs for all repos! When I was writing initial DocsNav scripts, I noticed that many repo's uses different and old version of Documenter, this approach will fix this too! Let's do it!

@penelopeysm
Copy link
Member Author

Okay. I'll merge this, tag a new version and then test it out on AbstractPPL :)

@penelopeysm penelopeysm merged commit cb8050c into main Nov 6, 2024
@penelopeysm
Copy link
Member Author

TuringLang/AbstractPPL.jl#110 😄

@penelopeysm penelopeysm deleted the py/multiple-actions branch December 5, 2024 14:22
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