search

cyclus / cycamore

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

Prettify Cycamore docs #626

Closed bennibbelink closed 1 week ago

bennibbelink commented 2 weeks ago

Makes essentially the same changes as https://github.com/cyclus/cyclus/pull/1787

zip for preview html.zip

github-actions[bot] commented 2 weeks ago

Build Status Report - 390f3bc0c47efda99c3f672e2596b53c9488b91d - 2024-09-21 10:02:24 -0400

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
gonuke commented 2 weeks ago

I'm happy to merge this now and wait for style sheet cross-repo fixes...

bennibbelink commented 2 weeks ago

Something odd is happening... the new style changes (for cyclus) are present in the artifact generated by cyclus.github.com actions but I'm not seeing them in the published site. The docs were present before adding them back into the build so I'm wondering if there's another server somewhere?

bennibbelink commented 2 weeks ago

Aha! The cyclus repo has Pages set up to serve the docs. Is it okay if I turn this (and the cycamore one) off? That way the docs will be accessible from just the cyclus.github.com site

gonuke commented 2 weeks ago

Just to make sure I understand... it seems that https://fuelcycle.org/cyclus/api/ is resolving to be the pages that are produced by GitHub at cyclus/cyclus on the gh-pages branch?

And that is blocking the ability to simply serve docs from the website file structure....

I think it's probably OK to turn of pages since the same URL will serve the new information and we never had a mechanism to automate the update of the go-pages.

The other alternative would be something that guarantees that the gh-pages are updated with every merged PR and/or release.

bennibbelink commented 2 weeks ago

it seems that https://fuelcycle.org/cyclus/api/ is resolving to be the pages that are produced by GitHub at cyclus/cyclus on the gh-pages branch?

And that is blocking the ability to simply serve docs from the website file structure....

Yes, this is my understanding.

The other alternative would be something that guarantees that the gh-pages are updated with every merged PR and/or release.

That is also an option. It would require that we maintain actions in cylus and cycamore to do this. I think I would lean toward managing all of the site content in one place (cyclus.github.com's Dockerfile) for the sake of transparency. Having subpaths of a website served from separate repositories doesn't feel very intuitive, and is part of the reason it took me so long to understand where those docs were being produced.

bennibbelink commented 2 weeks ago

Also I went ahead and changed this to find the stylesheet/gif at the location installed by cyclus.