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

Convert website to Sphinx #263

Merged
merged 38 commits into from
Dec 18, 2024
Merged

Conversation

speth
Copy link
Member

@speth speth commented Mar 7, 2024

Changes

TODO

  • Update CI configuration to run Sphinx

A version of the website built from this is available for exploration at https://testing.cantera.org. Since the new section layout is only currently available in the "dev" docs, this site has the "stable" docs replaced with the "dev" docs.

* Creates pdm lock files to install dependencies
* Creates Sphinx configuration files
* Moves content to Sphinx locations
The sphinx-design package enables nearly native support for Bootstrap
things like grids, cards, and more. This replaces our old Boostrap
plugin pretty neatly.
@speth speth added the enhancement New feature or request label Mar 7, 2024
pyproject.toml Outdated Show resolved Hide resolved
@bryanwweber
Copy link
Member

@speth Do you mind if I force-push this branch to remove my work email from the commits? Just want to check so you know when to reset --hard 😄

Copy link
Member

@ischoegl ischoegl left a comment

Choose a reason for hiding this comment

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

Thank you @speth (and @bryanwweber) for all your work on this.

From my end, I had a brief look at testing.cantera.org, but at the moment it still appears to be the Nikola theme? Or is it an exact clone in terms of appearance with the backend replaced?

@bryanwweber bryanwweber force-pushed the website-reformat-sphinx-myst branch from eb1a948 to 31c7e2a Compare March 8, 2024 16:41
@bryanwweber
Copy link
Member

@speth Do you mind if I force-push this branch to remove my work email from the commits? Just want to check so you know when to reset --hard 😄

@speth all set, thank you!

@speth speth force-pushed the website-reformat-sphinx-myst branch from 479766d to cd6fc33 Compare March 8, 2024 23:35
@speth
Copy link
Member Author

speth commented Mar 8, 2024

From my end, I had a brief look at testing.cantera.org, but at the moment it still appears to be the Nikola theme? Or is it an exact clone in terms of appearance with the backend replaced?

Sorry, looks like I had messed something up and what I had deployed got clobbered. I think it should be working now (and shouldn't get overwritten unless something gets pushed to the testing branch).

@speth speth mentioned this pull request Dec 14, 2024
5 tasks
Note, this effectively discards the changes that were made in 'main'
which are no longer relevant for this repository.
@speth speth marked this pull request as ready for review December 14, 2024 00:44
@speth speth requested a review from a team December 16, 2024 02:58
Copy link
Member

@bryanwweber bryanwweber left a comment

Choose a reason for hiding this comment

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

A few things look fishy with the configuration, but all the content changes seem fine 😄

source/conf.py Outdated Show resolved Hide resolved
source/conf.py Outdated Show resolved Hide resolved
source/conf.py Outdated Show resolved Hide resolved
source/conf.py Show resolved Hide resolved
@speth speth requested a review from bryanwweber December 16, 2024 15:45
@speth speth merged commit 8932c66 into Cantera:main Dec 18, 2024
1 check failed
@speth speth deleted the website-reformat-sphinx-myst branch December 18, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
3 participants