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

DOC Add versions to documentation #172

Closed
wants to merge 3 commits into from
Closed

Conversation

lucyleeow
Copy link
Collaborator

Aims to build document for all tagged versions and add versions to sidebar of documentation.

Outlines steps required: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/configuring.html#add-a-dropdown-to-switch-between-docs-versions

First attempt tries using sphinx-multiversion (as easier than writing all code our self). Note although this project has not seen much activity recently, see this comment from the author.

@lucyleeow
Copy link
Collaborator Author

To build with sphinx multiversion:

# Without sphinx-multiversion
sphinx-build docs build/html

# With sphinx-multiversion
sphinx-multiversion docs build/html

I am not sure if I should alter the current make file to have a 'make normal' and 'make multiversion' or just update the workflow yml to the multiversion. If the latter, I am not sure what the syntax @ means in @NAPARI_APPLICATION_IPY_INTERACTIVE=0

@lucyleeow
Copy link
Collaborator Author

Is there a way to tell if the docs are building via the CI .. ?

@jni
Copy link
Owner

jni commented May 8, 2022

For some reason, the docs builds aren't happening in this PR. You can see in #171, if you click on the green tick mark, the top action is "build docs" and you can click on it and view the artifact. In this PR, I think maybe the changes you've made to build-docs.yml may have made it a malformed yaml? The @ in that string is actually Makefile syntax and should be removed here.

@jni
Copy link
Owner

jni commented May 8, 2022

Also, @lucyleeow, now that the pydata theme has good versioning support, maybe we just switch the theme and use the pydata version switcher?

@lucyleeow
Copy link
Collaborator Author

Closed in favour of #173

@lucyleeow lucyleeow closed this May 10, 2022
@lucyleeow lucyleeow deleted the sphinx_multi branch May 10, 2022 10:59
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.

2 participants