Severson-Group / eMach

Open Source Machine Modeling and Optimization Framework. X Mach Speed.
https://emach.readthedocs.io
BSD 3-Clause "New" or "Revised" License
18 stars 3 forks source link

Figure out how RTD manages documentation versions #299

Closed npetersen2 closed 10 months ago

npetersen2 commented 1 year ago

Start by reading this: https://docs.readthedocs.io/en/stable/versions.html

npetersen2 commented 11 months ago

@elsevers and I will sit down and figure out how to get versions to appear on the RTD page.

An example of a project which does this nicely is: https://pymongo.readthedocs.io/

We should strive to replicate this type of capability, i.e., being able to look at published docs online from any released version.

npetersen2 commented 11 months ago

Next steps:

  1. Log into RTD and update latest to use eMach's develop branch
  2. Then, release code like AMDC-Firmware (release branches, tags, etc), see https://docs.amdc.dev/firmware/development/index.html
npetersen2 commented 10 months ago

This is completed by @elsevers