ReactionMechanismGenerator / ReactionMechanismGenerator/RMG-website

Feature: Access to Multiple Versions of the RMG Documentation

Open
#178 6 comments 0 reactions 1 assignee View on GitHub

@amarkpayne is already working on this.

Since Sep 24, 2019.

Feature User Experience
Dominant language
Python
Stars
22
Forks
30
PR merge metrics
No merged PRs in 30d

Description

Motivation or Problem

Currently, the RMG documentation on the website is based on the current version of master. This can create problems when a user who installed the "binary" version of RMG looks at the documentation, as there can be changes that don't apply for their installation. While it is of course possible to make the documentation from your current installation, this is not ideal.

Desired Solution

When someone goes to the documentation page of the RMG website, they should either be prompted to choose which version of RMG they are using, or they should have the ability to change to other versions of the documentation. Ideally, we would have the option for all releases as well as the current version of master, but it would be okay if we don't host versions of the documentation that are very old.

Potential Solutions
  • This appears to be a common feature for many other software projects that use sphinx, so we should look here first to see if sphinx can help with this

  • Worst case, we could manually setup this up on the RMG server by making the documentation for different versions in different folders, but this far from ideal.

Going Forward

By opening this feature issue, I would like to get the conversation going about what we want to implement and more importantly as a place to document our findings about different ways we might try to implement this. Please feel free to share your thoughts/ideas/findings below.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.