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

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from

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.

I think the plan for this PR should be to just push it as a separate 3.1 branch once people have had a chance to review the changes. After that, any updates to the main branch will need to be replicated here, and this branch will be merged with the main branch at the time of the Cantera 3.1 release, with all merge conflicts resolved in favor of this branch.

(To clarify: I think this is ready for review; It is marked as "draft" to prevent accidentally merging, though I guess that's not really an issue given the merge conflicts)

* 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
Comment on lines +43 to +47
[tool.pdm.options]
add = ["--no-self"]
sync = ["--no-self"]
install = ["--no-self"]
update = ["--no-self"]
Copy link
Member

Choose a reason for hiding this comment

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

pdm (at least as of 2.11) has an option to set up the project as an application. It's undocumented unless you start the project from scratch, but it goes:

[tool.pdm]
package-type = "application"

Then you can remove these no-self options.

@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
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).

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