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

The latest model version is not displayed correctly in documentation #463

Closed
nutrik opened this issue May 2, 2023 · 2 comments · Fixed by #466
Closed

The latest model version is not displayed correctly in documentation #463

nutrik opened this issue May 2, 2023 · 2 comments · Fixed by #466

Comments

@nutrik
Copy link
Collaborator

nutrik commented May 2, 2023

Hi Dion,

The code block below is not executed correctly during remote documentation generation on the GitHub side.
However, the locally built documentation looks OK. I was trying to fix it by adding "-e ." in the ./doc/requirements.txt file to let the remote building system access Veros installation (similar to my local environment), but it did not work.
Could you please take a look at it too?

      from veros import __version__ as veros_version
      if "+" in veros_version:
          veros_version, _ = veros_version.split("+")
      print(".. code-block::\n")
      print(f"   $ git clone https://github.com/team-ocean/veros.git -b v{veros_version}")
@dionhaefner
Copy link
Collaborator

It works on the stable docs: https://veros.readthedocs.io/en/stable/introduction/get-started.html

But not on latest because the build doesn't refer to a released version, so the version is undefined. I'll add some code that uses -b main in that case.

Should we change the default doc version to stable (latest release)?

@nutrik
Copy link
Collaborator Author

nutrik commented May 8, 2023

Thanks!
I do not have opinion about default doc version. I think it works well now.

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.

2 participants