DeepWok / mase

Machine-Learning Accelerator System Exploration Tools
Other
115 stars 52 forks source link

Generate docs for branches other than main #221

Open pgimenes opened 1 month ago

pgimenes commented 1 month ago

Currently we only generate docs for the main branch, published to https://deepwok.github.io/mase/

It would be useful to be able to access the generated doc for other branches, such as:

This would enable share doc drafts as they're written in development branches

pgimenes commented 1 month ago

@Aaron-Zhao123 would this be easy to implement?

pgimenes commented 1 month ago

https://holzhaus.github.io/sphinx-multiversion/master/index.html

Aaron-Zhao123 commented 1 month ago

The easist (at least what I do) is to run the doc building locally if I am on a dev branch?

cd docs
make html
open ./build/html/index.html

You should then be able to see the doc on your browser.