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

Makes non latest page clearer #78

Merged
merged 3 commits into from Nov 17, 2020
Merged

Makes non latest page clearer #78

merged 3 commits into from Nov 17, 2020

Conversation

dgarcia360
Copy link
Collaborator

@dgarcia360 dgarcia360 commented Nov 17, 2020

Closes #74

Adds the next warning note if the version being read differs from the latest version published.
The theme automatically detects which is the latest version published reading the environment variableLATEST_VERSION. This is set in runtime by the GitHub Action script: https://github.com/scylladb/sphinx-scylladb-theme/blob/master/.github/workflows/pages.yml#L32

image

How to test this PR

  1. Run the command make multiversion.
  2. Open the file docs/_build/master/examples/index.html with your favorite browser. Since LATEST_VERSION is set to master, you should not see any warning.
  3. Open the file docs/_build/0.1.8/examples/index.html. You should see the warning.

Note: If you want to test locally setting LATEST_VERSION to another version (e.g. 0.1.13), run in your terminal export LATEST_VERSION = 0.1.13 before make multiversion.

Copy link
Collaborator

@tzach tzach left a comment

Choose a reason for hiding this comment

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

LGTM

@dgarcia360 dgarcia360 merged commit d5ccb07 into scylladb:master Nov 17, 2020
@dgarcia360 dgarcia360 deleted the non-latest-page-clearer branch November 17, 2020 15:38
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 this pull request may close these issues.

Make non latest page clearer
2 participants