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

Provide links to previous Doxygen documentation #1551

Merged
merged 4 commits into from
Jul 28, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 22, 2023

Changes proposed in this pull request

Make previous versions of Doxygen documentation easier to find (from current Doxygen page).

Also, fix a couple of Doxygen issues that prevent proper rendering of math equations or cross-references.

While there are - at least some - other projects that have implemented a version switcher for Doxygen documentation (example: OpenCV), this would presumably require regeneration of old documentation. Creating a page with links is a much simpler solution.

Addresses Cantera/enhancements#179

If applicable, provide an example illustrating new features this pull request is introducing

image

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@ischoegl ischoegl marked this pull request as ready for review July 22, 2023 18:28
@ischoegl ischoegl requested a review from a team July 22, 2023 18:29
An excessive number of white spaces prevents proper rendering of
mathematical expressions.
speth
speth previously approved these changes Jul 27, 2023
Copy link
Member

@speth speth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems straightforward enough. I guess updating this needs to be added to the list of things done for each release, though at least in this case it's something that can be done after a release.

One question: do you want to add a link to the dev/latest docs?

@ischoegl
Copy link
Member Author

One question: do you want to add a link to the dev/latest docs?

Great suggestion! (although it dismisses the review)

@speth speth merged commit a5b704d into Cantera:main Jul 28, 2023
40 checks passed
@ischoegl ischoegl deleted the previous-doxygen branch July 28, 2023 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants