-
Notifications
You must be signed in to change notification settings - Fork 26
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
base: main
Are you sure you want to change the base?
Conversation
* 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.
[tool.pdm.options] | ||
add = ["--no-self"] | ||
sync = ["--no-self"] | ||
install = ["--no-self"] | ||
update = ["--no-self"] |
There was a problem hiding this comment.
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.
@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 |
There was a problem hiding this 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?
eb1a948
to
31c7e2a
Compare
479766d
to
cd6fc33
Compare
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 |
Changes
TODO
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 themain
branch will need to be replicated here, and this branch will be merged with themain
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)