search

cyclus / cycamore

The CYClus Additional Module REpository
Other
15 stars 39 forks source link

Fix link in `DEPENDENCIES.rst` #595

Closed bennibbelink closed 5 months ago

bennibbelink commented 5 months ago

Closes #594. Needed to add a space between the link text and the brackets. Renders correctly on my local site build.

image

github-actions[bot] commented 5 months ago

Build Status Report - 796f798973ac3e7aab61ea749ec48f9fd3b970fd - 2024-04-29 14:34:54 -0500

Build FROM cyclus_20.04_apt/cyclus:latest
Build FROM cyclus_20.04_apt/cyclus:stable
Build FROM cyclus_20.04_conda/cyclus:latest
Build FROM cyclus_20.04_conda/cyclus:stable
Build FROM cyclus_22.04_apt/cyclus:latest
Build FROM cyclus_22.04_apt/cyclus:stable
Build FROM cyclus_22.04_conda/cyclus:latest
Build FROM cyclus_22.04_conda/cyclus:stable
bennibbelink commented 5 months ago

I am having trouble fixing the numbering. It seems to be finicky since we're injecting sections of DEPENDENCIES.rst into the middle of a numbered list in user/install_binary.rst.

abachma2 commented 5 months ago

I was thinking that part might be tricky. If it's not possible for now, I won't let that block this PR from being merged.

gonuke commented 5 months ago

What's the best way to preview how these things end up in the website? I'm guessing it's a lot of temporary local customization???...

abachma2 commented 5 months ago

Personally, I copy the contents of this file into the source/user/CYCAMORE_DEPS.rst file in the website repo, then remove the line in the Makefile that pulls it from this repo. That way it won't overwrite that file when you build via make gh-preview.

That, or you can change the Makefile to point to this fork and repo for this file, but I've found that doesn't always capture the latest updates to the file for some reason.

bennibbelink commented 5 months ago

That, or you can change the Makefile to point to this fork and repo for this file, but I've found that doesn't always capture the latest updates to the file for some reason.

Near the top of the Makefile in cyclus/cyclus.github.com there are variables set for CYCAMORE_GIT_FORK and CYCAMORE_GIT_BRANCH. If you set them to bennibbelink and fix-link, respectively, the DEPENDENCIES.rst and INSTALL.rst from this branch will get fetched and built into the local site. This is my typical workflow, I have noticed that there is a slight delay from when you push to GitHub and when those changes will be fetched, similar to @abachma2, but usually its on the order of a minute or two.

gonuke commented 5 months ago

To test this in conjunction with cyclus/cyclus.github.com#364, do I need to do an ad-hoc change to the Makefile in cyclus/cyclus.github.com#364 so that it loads this updated version?

bennibbelink commented 5 months ago

To test this in conjunction with cyclus/cyclus.github.com#364, do I need to do an ad-hoc change to the Makefile in cyclus/cyclus.github.com#364 so that it loads this updated version?

Correct, you need to reference my fork and the fix-link branch.

gonuke commented 5 months ago

Let's dive in and see how this comes together on the website