Closed ischoegl closed 1 year ago
The links from the main
branch should point to the dev
docs. If that's still the case on the 2.6 branch, then it's just another symptom of the problem that would be fixed by my approach to Cantera/enhancements#178.
The link is from https://cantera.org/documentation/docs-2.6/sphinx/html/yaml/phases.html?highlight=lewis, so this is definitely incorrect. It appears that all links would have to be replaced when posting stable versions to the website - I guess it may be a website bug after all.
Fwiw, Cantera/cantera#1548 implements a fix in line with Cantera/enhancements#178 ... I realize that it's controversial
For the upcoming release, this is addressed by doxylink
references introduced in Cantera/cantera#1572
Can we close this issue? I don't think going back and fixing links in 2.6 documentation would be a good use of time.
👍
Problem description
Following a link in a recent UG question, it becomes apparent that there is a mismatch of version between documentations (which after https://github.com/Cantera/cantera/pull/1546 becomes a lot more apparent than it was in the past).
The link in the referenced document is https://cantera.org/documentation/dev/doxygen/html/d3/dd6/classCantera_1_1UnityLewisTransport.html#details which originates here: https://github.com/Cantera/cantera/blob/5f1014c1a0c3f710db0cc2448e47bacddbb4617d/doc/sphinx/yaml/phases.rst?plain=1#L137-L149
There appear to be quite a few other instances where reST files point to the wrong version.
Additional context
While this appears to be a website issue, the offending documentation is part of the main repository.