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.

Sign up for GitHub

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

Jump to bottom

Add PyMUSAS version to the documentation site #21

Open
apmoore1 opened this issue Jan 5, 2022 · 0 comments
Open

Add PyMUSAS version to the documentation site #21

apmoore1 opened this issue Jan 5, 2022 · 0 comments
Assignees
@apmoore1
Labels
documentation Improvements or additions to documentation

Comments

@apmoore1
Copy link
Member

apmoore1 commented Jan 5, 2022

Problem

At the moment the documentation site is update when it is update on the main GitHub branch. This will cause problems when we add functionality to the latest PyMUSAS version that is currently on the main GitHub branch and is ahead in terms of functionality of the latest version of PyMUSAS on PyPI.

Solution

To add versioning to the documentation site so that we have documentation that relates to both:

  1. The latest version of PyMUSAS on PyPI, and
  2. Documentation that relates to the latest version of PyMUSAS on the main GitHub branch.

This can be done using the versioning feature within docusaurus, the documentation website generator that we use.
@apmoore1 apmoore1 added the documentation Improvements or additions to documentation label Jan 5, 2022
@apmoore1 apmoore1 self-assigned this Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@apmoore1 apmoore1

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@apmoore1