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

Allow access to latest documentation version through stable URL #229

Open
corykinney opened this issue Nov 4, 2022 · 1 comment · May be fixed by #263
Open

Allow access to latest documentation version through stable URL #229

corykinney opened this issue Nov 4, 2022 · 1 comment · May be fixed by #263
Assignees

Comments

@corykinney
Copy link
Contributor

As it is now, if I were wanting to link to the ct.Reactor documentation I would link to https://cantera.org/documentation/docs-2.6/sphinx/html/cython/zerodim.html#reactor. When Cantera 3.0 is released, the link will no longer point at the latest documentation. It would be nice if the latest version of the documentation were always accessible at a stable URL; for instance, with NumPy the latest version of documentation for np.nan would always be at https://numpy.org/doc/stable/reference/constants.html#numpy.NAN.

I am proposing that the URL https://cantera.org/documentation/stable/... would currently host the 2.6 documentation, until the point at which 3.0 is released. At that point, the same URL would then point at the 3.0 documentation, and the 2.6 documentation would be moved to https://cantera.org/documentation/2.6/.... It would be especially helpful if there were a version selector on the documentation page in this case.

On a related note, it would also be nice if the URLs were shorter. Currently the python documentation is prefixed by sphinx/html/cython which is understandable, as it is informative of the underlying implementation, but I think simply using python as the prefix could be much more user friendly. Similarly, substituting docs for documentation. For example: https://cantera.org/docs/stable/python/zerodim.html#reactor.

I'd be curious to hear others thoughts on this. I'm not sure if there are any limitations on how this could break existing links.

@ischoegl
Copy link
Member

ischoegl commented Aug 4, 2023

Linking some old discussion from Cantera/enhancements#150 ...

speth added a commit to speth/cantera that referenced this issue Sep 30, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Sep 30, 2023
speth added a commit to speth/cantera that referenced this issue Oct 1, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 1, 2023
speth added a commit to speth/cantera that referenced this issue Oct 3, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 3, 2023
speth added a commit to speth/cantera that referenced this issue Oct 3, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 3, 2023
speth added a commit to speth/cantera that referenced this issue Oct 6, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 6, 2023
speth added a commit to speth/cantera that referenced this issue Oct 8, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 8, 2023
speth added a commit to speth/cantera-website that referenced this issue Oct 8, 2023
speth added a commit to speth/cantera that referenced this issue Oct 9, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to speth/cantera that referenced this issue Oct 9, 2023
speth added a commit to speth/cantera that referenced this issue Oct 9, 2023
speth added a commit that referenced this issue Oct 9, 2023
speth added a commit to Cantera/cantera that referenced this issue Oct 9, 2023
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx
index can be the full site index.

Partially addresses Cantera/cantera-website#229
speth added a commit to Cantera/cantera that referenced this issue Oct 9, 2023
@speth speth linked a pull request Mar 7, 2024 that will close this issue
@speth speth self-assigned this Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants