Skip to content

Refactor documentation workflow#151

Merged
pwochner merged 29 commits intomasterfrom
refactor/documentation-ci
Jul 22, 2025
Merged

Refactor documentation workflow#151
pwochner merged 29 commits intomasterfrom
refactor/documentation-ci

Conversation

@pwochner
Copy link
Member

@pwochner pwochner commented Mar 31, 2025

Description:

This PR updates the documentation workflow to remove Python dependencies since we've fully migrated from Jupyter notebooks to Pluto.jl, and to build docs from master branch. Changes include:

  • Merges documentation into master
  • Builds documentation from master branch.
  • Removes Python 3.10 setup step
  • Removes installation of jupyterlab and nbconvert
  • Removes dependency on PlutoUI (caused dependency errors and was only used for displaying a table of contents in Pluto notebooks)
  • Update Getting started with constraints tutorial to reflect recent changes to addconstraint! (implement issame and is_domain_valid for custom constraint in tutorial)
  • Disables Pluto's package manager (see Pluto notebooks for tutorials: CI doesn't update dependencies in embedded Manifest.toml #170 )

Closes #135
Closes #170

@pwochner pwochner changed the base branch from master to documentation April 2, 2025 10:47
@pwochner pwochner changed the base branch from documentation to master April 2, 2025 10:49
@pwochner pwochner marked this pull request as ready for review April 2, 2025 11:09
@THinnerichs THinnerichs self-requested a review April 2, 2025 12:44
@pwochner
Copy link
Member Author

pwochner commented Jul 4, 2025

#169 has to be addressed first.

@pwochner pwochner marked this pull request as draft July 4, 2025 11:25
@pwochner pwochner marked this pull request as ready for review July 14, 2025 13:23
@pwochner pwochner requested a review from ReubenJ July 16, 2025 16:30
Copy link
Member

@ReubenJ ReubenJ left a comment

Choose a reason for hiding this comment

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

Just noticed the odd ticks in the installation guide. Feel free to merge with to without the change. We can address that in another PR if you merge without it.

```

which will both install all dependencies automatically.
`which` will both install all dependencies automatically.
Copy link
Member

Choose a reason for hiding this comment

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

Does this need to be in `...`s?


And just like this you are done! Welcome to Herb.jl!

## Julia How-To
Copy link
Member

Choose a reason for hiding this comment

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

I think I'd like to remove this in the future and point somewhere that's maintained by the Julia team, but for now we can leave it

Copy link
Member Author

Choose a reason for hiding this comment

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

I opened #172 as a reminder.

@pwochner pwochner dismissed THinnerichs’s stale review July 22, 2025 12:30

Requested changes to fix indentation have been addressed. In addition, Reuben reviewed PR.

@pwochner pwochner merged commit a52a8e0 into master Jul 22, 2025
6 of 7 checks passed
@pwochner pwochner deleted the refactor/documentation-ci branch July 22, 2025 12:30
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.

Pluto notebooks for tutorials: CI doesn't update dependencies in embedded Manifest.toml Build documentation from master branch

3 participants