Flowsheet Documentation for GAC #1396
Conversation
| Implementation | ||
| -------------- | ||
|
|
||
| As a single unit operation, the assumptions for the flowsheet are aligned with those detailed in the :doc:`GAC unit model documentation <../unit_models/gac>`. |
There was a problem hiding this comment.
@MarcusHolly I'm going to point you to this because I see you were hard linking some internal documentation hyperlinks in the flowsheet documentation. I think this method is better because it should link to the version of the documentation the reader is using instead of having the hard link to latest. But honestly someone more familiar than me with .rst compiling should give a recommendation.
There was a problem hiding this comment.
Thanks for the suggestion Hunter. I definitely think this is better than hard-coding. This change should probably be applied across the board tho (not just flowsheet documentation) since I believe most links are hard-coded. This probably warrants it's own PR.
There was a problem hiding this comment.
So I was looking through the docs to see how it is done to get this one in, and the answer is that it depends. I think all the core files like getting started and how-to's use .rst utilities instead of hard linking, but they rely on establishing a name at the top of certain documentation files (which the unit models don't have but the how-to's and others do) and then referencing the name inline, instead of here which references the file path tree to the desired link.
There was a problem hiding this comment.
From a quick skim, it looks like some flowsheets, unit models, and one property model documentation are hard-coding links
There was a problem hiding this comment.
Maybe the best solution it to just change the hard-coded link from latest to stable because a user might have an outdated version of the documentation, and we would still want the links to re-direct them to more up-to-date documentation. I see that some documentation does this already (getting_started.rst, how_to_setup_simple_chemistrt.rst, etc.)
There was a problem hiding this comment.
IMO you would always want the version to stay the same before and after clicking the link which you can't get through hard-coding, but yea this would be a tedious review of the current documentation.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1396 +/- ##
=======================================
Coverage 94.01% 94.01%
=======================================
Files 335 335
Lines 35561 35561
=======================================
Hits 33431 33431
Misses 2130 2130 ☔ View full report in Codecov by Sentry. |
| @@ -96,6 +96,10 @@ | |||
| # | |||
| html_favicon = "_static/favicon.ico" | |||
|
|
|||
| # intersphinx mapping to idaes | |||
| intersphinx_mapping = { | |||
There was a problem hiding this comment.
@TimBartholomew @ksbeattie @lbianchi-lbl Are there any downsides to adding this? See https://docs.readthedocs.io/en/stable/guides/intersphinx.html
There was a problem hiding this comment.
There was a problem hiding this comment.
From the looks of it, intersphinx mapping seems like the better way to go--even though we have other ways of dealing with these links without hard-coding to a version from my vague recollection. Can't speak to the downsides though. @lbianchi-lbl @dangunter - any thoughts?
There was a problem hiding this comment.
Sorry for the late reply, I missed the notification(s). I think InterSphinx mappings is a good approach. I've tested that the GAC links to the IDAES docs work as expected on this PR's ReadTheDocs build.
* writing doc for gac fs * trying to reference unit model through hyperlink * fixing indentation * revising based on the readthedocs build * revising based on the readthedocs build * fixing indentation * fixing indentation * testing implementation of idaes linking * fixing linking * testing the different filepath formats * testing the different filepath formats * fixing the linking * fixing the idaes linking * changing punctuation * changing to conventions --------- Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
Fixes/Resolves:
GAC flowsheet documentation for #1219
Summary/Motivation:
Adding GAC flowsheet documentation
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: