search

lnis-uofu / OpenFPGA

An Open-source FPGA IP Generator
https://openfpga.readthedocs.io/en/master/
MIT License
813 stars 161 forks source link

Move OpenFPGA docs to github pages #181

Closed ganeshgore closed 3 years ago

ganeshgore commented 3 years ago

Is your feature request related to a problem? Please describe. Move doc building to gh-pages than readthedocs, because

  1. reduces the dependencies on other services
  2. gh-pages are more customizable

Describe the solution you'd like Create a docker image to build docs on the master branch and deploy on dedicated gh-pages branch

Describe alternatives you've considered Seems feasible to achieve above thing

Additional context It will be great if we could build docs for push requests as well (if there are any changes) and have it hosted in the same github pages. It will make documentation review much faster.

tangxifan commented 3 years ago

Currently, readthedocs is still working well. We can preview the documentation for any pull request:

image

So, I will hold this issue until that readthedocs can no longer fit our needs.

mithro commented 3 years ago

I would highly recommend sticking with readthedocs.