[FEAT-REQ] Publishing docs on readthedocs automatically using Github Actions
danielRep opened this issue · comments
Discussed in #11
Originally posted by josecm July 1, 2022
@danielRep Maybe we should start automating build the publishing of the documentation using Github Actions. What do you think?
I generally like the idea. I'll bring this topic about "pre-releasing" publicly the documentation on the next meeting and if approved I'll try to save some cycles to implement this.
@danielRep I'm circling back to this as I believe it would be very useful to have a link we could refer to.
We have a problem regarding the needed connection between the readthedocs and github. Supposdelky, readthedocs only allows hosting to public repositories:
https://docs.readthedocs.io/en/stable/commercial/index.html
Read the Docs is our community solution for open source projects at readthedocs.org and we offer Read the Docs for Business for building and hosting commercial documentation at readthedocs.com. Features in this section are specific to Read the Docs for Business.
Private repositories and private documentation
The largest difference between the community solution and our commercial offering is the ability to connect to private repositories, to restrict documentation access to certain users, or to share private documentation via private hyperlinks.
Read the Docs Community¶
Only supports public VCS repositories
Read the Docs for Business¶
Allows importing private and public repositories from VCS
However, we can install readthedocs in a server or local machine. But the engineering effort must be harder:
readthedocs/readthedocs.org#3258
Need to evaluate