-
Notifications
You must be signed in to change notification settings - Fork 0
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
Deploy multi version docs to subdomain using pyansys/actions v4 #268
Conversation
Codecov Report
@@ Coverage Diff @@
## main #268 +/- ##
=======================================
Coverage 95.32% 95.32%
=======================================
Files 10 10
Lines 1369 1369
=======================================
Hits 1305 1305
Misses 64 64 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
Approved, assuming this PR won't do anything that might impact the current live pages without some other config changes
"additional_breadcrumbs": [("PyAnsys Documentation", "https://docs.pyansys.com/")], | ||
"additional_breadcrumbs": [ | ||
("PyAnsys Documentation", "https://docs.pyansys.com/"), | ||
("Granta MI", "https://grantami.docs.pyansys.com/"), |
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.
So when this is merged, we'll start pushing dev docs builds, but they'll go to this repo, so it won't break the existing live docs. Is that right?
Just making sure that nothing we're changing here goes public until we're ready.
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.
I'm not sure if publishing will work at all, because the cname is not available.
But it wouldn't affect existing docs, as they are still generated from the other repo
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.
At this point we could request bomanalytics.grantami.docs.pyansys.com. For a while we'd have the bomanalytics docs served both at bomanalytics.grantami
and grantami
, but that would enable to sort things through before changing the landing page at grantami.docs
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.
That makes sense. We could even get to the point of having the bomanalytics docs live, and then only change the grantami page from bomanalytics to the Granta MI page when we want to release recordlists.
Sounds good to me. Yes, go ahead and request bomanalytics.grantami....
* Bump theme version * Deploy multi version docs to subdomain using pyansys/actions v4 (#268) * Docs: bump theme version (#272) * Bump theme * Add favicon * Update conf.py * Remove JSON docs * Update direct links to the docs * Bump version to 1.1.2 * Black formatting * Prevent dev docs deployment on tag push * Change release job dependency
Modify CI to use doc deployment actions from pyansys/actions v4.
Bump version of sphinx theme to support multi-version
Configures sphinx for multi-version
Currently configured to use cname
bomanalytics.grantami.docs.pyansys.com
which hasn't been requested/verified yet