[core-workflow] Voting on possible subdomains for the devguide
Oleg Broytman
phd at phdru.name
Tue Apr 11 14:37:03 EDT 2017
On Tue, Apr 11, 2017 at 02:28:20PM -0400, Elvis Pranskevichus <elprans at gmail.com> wrote:
> On Tuesday, April 11, 2017 2:09:33 PM EDT Oleg Broytman wrote:
> > On Tue, Apr 11, 2017 at 05:58:38PM +0000, Brett Cannon <brett at python.org> wrote:
> > > On Tue, 11 Apr 2017 at 10:52 Elvis Pranskevichus <elprans at gmail.com> wrote:
> > > > On Tuesday, April 11, 2017 1:41:45 PM EDT Guido van Rossum wrote:
> > > > > Last I heard from then, RTD was struggling financially. Hosting
> > > > > isn't
> > > > > really free, you know -- nor is administering a site like that
> > > > > :-).
> > > > > The PSF should offer to cover their costs for hosting the Python
> > > > > docs, which I presume are pretty dang popular compared to many
> > > > > other
> > > > > things currently hosted at RTD -- the peps and devguide won't
> > > > > cause
> > > > > any load in comparison.
> > > >
> > > > Is Gihub Pages considered an option? We host the asyncpg docs [1]
> > > > there. Builds are done by Travis. The advantage is that we don't
> > > > have to add another service dependency.
> > >
> > > I guess so. No one has ever suggested it before or bothered to set
> > > it up to show how it would work. :)
> >
> > GH Pages don't need much to setup. You have to choose between Org
> > Pages (at the root of the subdomain) and Repo Pages (in
> > subdirectories). I even believe GH Pages can do both on the same
> > subdomain but I've never tried.
>
> GH Pages support custom domain redirects [1]. "setup" in this case
> is putting together scripts to automate sphinx runs and the git push
> of the compiled output to the appropriate repo/branch. If there's
> interest in pursuing this option, I can help with setting things up.
>
> [1] https://help.github.com/articles/custom-domain-redirects-for-github-pages-sites/
For Org Pages with a custom domain you also need a CNAME file at the
root of the repo.
To publish Sphinx-generated sites you need an empty .nojekyll file at
the root. Without it GitHub blocks special Sphinx directories (those
ones that starts with an underscore).
> Elvis
Oleg.
--
Oleg Broytman http://phdru.name/ phd at phdru.name
Programmers don't die, they just GOSUB without RETURN.
More information about the core-workflow
mailing list