On Sat, Jul 18, 2020, 4:52 AM <sphinx_2...@michaelaltfield.net> wrote:
> Hello, > > I just published an article on how to host a sphinx/read-the-docs site on > GitHub Pages using GitHub Actions: > > * https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/ > > This email is an attempt to respond to this old thread asking how to host > rtd (just in-case googlegroups doesn't understand the "In-Reply-To" Header > I'm setting): > > * > https://groups.google.com/forum/#!searchin/sphinx-users/versions$20%22latest%22|sort:date/sphinx-users/huLkunvBy-8/BJgrWE3tQ8cJ > <https://groups.google.com/forum/#!searchin/sphinx-users/versions$20%22latest%22%7Csort:date/sphinx-users/huLkunvBy-8/BJgrWE3tQ8cJ> > > ^ That thread was posted in 2014 and still hasn't received any responses. > I found it when trying to set this up myself, which I found to be > annoyingly opaque. So I wrote the above guide to help others achieve this. > > > I want to mimic two main other features: > > - The menu in the lower left with the different versions (from git > branches and tags), downloads etc. > > - The "edit on github" button > > Part two of my guide (yet to be published) will cover adding the > lower-left for accessing different languages, versions, and downloads. > > It will also address the "Edit on GitHub," which I've also already > documented on Stack Overflow: > > * https://stackoverflow.com/q/62904172/1174102 > > I've managed to get the lower-left to be visible by setting 'READTHEDOCS' > to 'True' in the 'html_context' dict() in 'conf.py' -- which I found only > by digging through the code. Sadly, it doesn't appear to be documented > anywhere. Similarly, I was able to populate the versions, downloads, and > languages by populating 'versions', 'downloads', and 'subprojects' to a > list of tuples in each. > > I'll describe this more thoroughly in part two of my article linked-to > above. > > In the meantime, can someone please point me to the documentation that > describes the above variables, if any? Specifically, I'd like to know about > the internals of the internationalization and versions in rtd -- like why > is 'languages' called 'subprojects'? > > > Cheers, > > Michael Altfield > https://www.michaelaltfield.net > PGP Fingerprint: 0465 E42F 7120 6785 E972 644C FE1B 8449 4E64 0D41 > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to sphinx-users+unsubscr...@googlegroups.com. > To view this discussion on the web visit > https://groups.google.com/d/msgid/sphinx-users/20200718114739.GA27401%40mail.michaelaltfield.net > . > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/CAELGjd8OK5bibyYF%2BgP1Tf6RtJLAJ7LfPNth_CK1Bx_1FAoJHw%40mail.gmail.com.
