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

Stable documentation (2.6) points to development C++ Reference #250

Closed
ischoegl opened this issue Jul 20, 2023 · 5 comments
Closed

Stable documentation (2.6) points to development C++ Reference #250

ischoegl opened this issue Jul 20, 2023 · 5 comments
Labels
bug Something isn't working

Comments

@ischoegl
Copy link
Member

ischoegl commented Jul 20, 2023

Problem description

Following a link in a recent UG question, it becomes apparent that there is a mismatch of version between documentations (which after Cantera/cantera#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.

@ischoegl ischoegl added the bug Something isn't working label Jul 20, 2023
@speth
Copy link
Member

speth commented Jul 20, 2023

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.

@ischoegl
Copy link
Member Author

ischoegl commented Jul 20, 2023

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

@ischoegl ischoegl transferred this issue from Cantera/cantera Jul 20, 2023
@ischoegl
Copy link
Member Author

ischoegl commented Aug 9, 2023

For the upcoming release, this is addressed by doxylink references introduced in Cantera/cantera#1572

@speth
Copy link
Member

speth commented Sep 1, 2023

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.

@ischoegl
Copy link
Member Author

ischoegl commented Sep 1, 2023

👍

@ischoegl ischoegl closed this as completed Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants