[Distutils] Proposal: moving PyPA projects to pydoctheme

[Wes Turner]

On Saturday, May 27, 2017, Ionel Cristian Mărieș via Distutils-SIG <
distutils-sig at python.org> wrote:

> Interestingly this doesn't have the "sticky" sidebar (eg: it moves as you
> scroll page) as the py3 docs have. This is my attempt to package it into a
> reusable theme btw: http://ionelmc.github.io/sphinx-py3doc-enhanced-theme/
> bare/reference/foo.bar.html
>
> You probably don't want to use that directly but maybe there is stuff you
> can just copy from it.
>

Here's a (somewhat hackish) sticky sidebar w/:

- sphinxjp.themes.basicstrap
  - https://pypi.python.org/pypi/sphinxjp.themes.basicstrap/
  - responsive
    - toggle-able mobile TOC
- (toggle) show :visited links
- (toggle) open external links in new tab
- jquery.scrollTo the current TOC heading
- sphinxcontrib-srclinks
  - https://pypi.python.org/pypi/sphinxcontrib-srclinks
  - project homepage, src hyperlinks
  - git/hg clone commands


Example: https://wrdrd.github.io/docs/tools/#sphinx

https://github.com/wrdrd/docs/blob/master/Makefile
- make localjs
  https://github.com/wrdrd/docs/tree/master/docs/_static/js
 - newtab.js - open links in a new tab (and store the setting in a cookie)
 - sidenav-affix.js - sticky sidebar
 - sidenav-scrollto.js - indicate current TOC heading (and scroll the TOC
entry into view only of it's out of the viewport)

If any of these are useful, please feel free or just let me know and I'll
go ahead and package them up.

... https://github.com/yoloseem/awesome-sphinxdoc


>
> Thanks,
> -- Ionel Cristian Mărieș, http://blog.ionelmc.ro
>
> On Fri, May 26, 2017 at 7:32 PM, Jon Wayne Parrott via Distutils-SIG <
> distutils-sig at python.org
> <javascript:_e(%7B%7D,'cvml','distutils-sig at python.org');>> wrote:
>
>> Awesome, more good feedback. I've made some stylesheet adjustments to
>> highlight both the current page (by bolding) and the current section (by
>> coloring links). Let me know on the PR if you have alternative
>> recommendations (leaving out the current section coloring is actually fine,
>> IMO). Staged again here (http://temp.theadora.io/pypug
>> -pydoctheme/self_hosted_repository.html).
>>
>> Since we mostly seem to all be in agreement, can someone who's an admin
>> on the PyPA org create the pypa-theme repository for me?
>>
>> On Fri, May 26, 2017 at 5:13 AM Nick Coghlan <ncoghlan at gmail.com
>> <javascript:_e(%7B%7D,'cvml','ncoghlan at gmail.com');>> wrote:
>>
>>> Thanks for working on this, Jon!
>>>
>>> On 26 May 2017 at 17:06, Nathaniel Smith <njs at pobox.com
>>> <javascript:_e(%7B%7D,'cvml','njs at pobox.com');>> wrote:
>>> > Further nitpick: the new version shows the whole ToC, but doesn't do
>>> > anything to mark which part of it corresponds to the current page (cf
>>> > the RTD theme's grey box), which makes it hard to orient oneself when
>>> > looking at it. Some sort of "you are here" indicator would help :-)
>>>
>>> While the subtree expansion does provide a bit of that, I do agree
>>> that some additional contrast between the expanded section and the
>>> rest of the ToC would be beneficial.
>>>
>>> Cheers,
>>> Nick.
>>>
>>> --
>>> Nick Coghlan   |   ncoghlan at gmail.com
>>> <javascript:_e(%7B%7D,'cvml','ncoghlan at gmail.com');>   |   Brisbane,
>>> Australia
>>>
>>
>> _______________________________________________
>> Distutils-SIG maillist  -  Distutils-SIG at python.org
>> <javascript:_e(%7B%7D,'cvml','Distutils-SIG at python.org');>
>> https://mail.python.org/mailman/listinfo/distutils-sig
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20170531/da365592/attachment.html>