Bug#915583: debian sphinx styling: second attempt

[Sam Hartman]

> "Stéphane" == Stéphane Blondon  writes:

Stéphane> Le ven. 3 nov. 2023 à 15:43, Sam Hartman
Stéphane>  a écrit :
>> > "Sean" == Sean Whitton  writes:
>> 
>> I'm happy to test with Orca on Firefox on Debian.  Feel free to
>> point me at a URL.
>> 


Stéphane> You can test it at: http://stephane.yaal.fr/tmp/policy/

Given a quick look, appears okay to me.

Bug#915583: debian sphinx styling: second attempt

[Stéphane Blondon]

Le ven. 3 nov. 2023 à 15:43, Sam Hartman  a écrit :

> > "Sean" == Sean Whitton  writes:
>
> I'm happy to test with Orca on Firefox on Debian.
> Feel free to point me at a URL.
>


You can test it at:
http://stephane.yaal.fr/tmp/policy/

Regards

>

Bug#915583: debian sphinx styling: second attempt

[Sam Hartman]

> "Sean" == Sean Whitton  writes:

Sean> - it would be good to do some accessibility testing of some
Sean> kind, at least with screenreaders.  But maybe the fact that
Sean> you've based your theme on an existing, popular Sphinx theme
Sean> means this is covered?

I'm happy to test with Orca on Firefox on Debian.
Feel free to point me at a URL.

Bug#915583: debian sphinx styling: second attempt

[Sean Whitton]

Hello Stéphane,

Thank you for working on this.  A couple of things I have written in my
notes, from years ago, on this topic:

- it would be good for footnote references to stand out more than they
  do at present.  I think your theme achieves this.

- it would be good to do some accessibility testing of some kind, at
  least with screenreaders.  But maybe the fact that you've based your
  theme on an existing, popular Sphinx theme means this is covered?

Thanks again.

-- 
Sean Whitton


signature.asc
Description: PGP signature

Re: Bug#915583: debian sphinx styling: second attempt

[Russ Allbery]

RL  writes:

> http://stephane.yaal.fr/tmp/release-notes/issues.html#grub-no-longer-runs-os-prober-by-default
> the '# dpkg-reconfigure ' is shown as a shell-comment, but is
> meant to be a command-to-run-as-root (i remember this being discussed on
> the previous version on the release-notes list, and i thought someone
> had posted a way to fix it?)

The sphinx-prompt extension plus using:

.. prompt:: bash
   :prompts: #

   dpkg-reconfigure 

will fix this, with the added bonus of removing the # prompt from the text
that is selected when the user cuts and pastes, so they can cut and paste
just the command.

-- 
Russ Allbery (r...@debian.org)  

Re: Bug#915583: debian sphinx styling: second attempt

[RL]

Stéphane Blondon  writes:

>  - for (draft sphinx) release-notes: 
> http://stephane.yaal.fr/tmp/release-notes/
>
> What do you think about it?

commenting on the release-notes, but i expect applies to policy too:

looks awesome - imo it is now even better-looking than the docbook verison

in the tables, eg package list under
   http://stephane.yaal.fr/tmp/release-notes/whats-new.html runningnthe
   mouse over the rows and headers does some changes to the font which
   is a bit confusing, eg the "dark" rows end up near-white on white:
   suggest disabling this

http://stephane.yaal.fr/tmp/release-notes/issues.html#grub-no-longer-runs-os-prober-by-default
the '# dpkg-reconfigure ' is shown as a shell-comment, but is
meant to be a command-to-run-as-root (i remember this being discussed on
the previous version on the release-notes list, and i thought someone
had posted a way to fix it?)

When things are in the orange-on-grey boxes it looks to me like the grey
   boxes are not quite vertically centred, eg in
   
http://stephane.yaal.fr/tmp/release-notes/issues.html#rsyslog-changes-affecting-log-analyzers-such-as-logcheck

   the 'rsyslog' beofre the closing parenthesis the top of box is
   aligned to the top of the ")" but the bottom of the box extends
   below)

  (and i wonder if a slightly darker (ie red-er) orange would be a bit
  more readable, or wether changing foreground and adding the box is a
  bit much?)

Bug#915583: debian sphinx styling: second attempt

[Russ Allbery]

Stéphane Blondon  writes:

> I've done a new version. It's based on 'sphinx_rtd_theme' theme. So, to
> build the site, the package 'python3-sphinx-rtd-theme' requires to be
> added to dependencies. A new file 'debian.css' is specific to set some
> colors and renderings.

> Reusing 'Read the docs' theme allows to have a responsive design
> automatically.

> The theme could be modified more but it could be considered as a first
> step which is already usable.

> There are temporary demos available:
>  - for debian-policy: http://stephane.yaal.fr/tmp/policy/
>  - for (draft sphinx) release-notes: 
> http://stephane.yaal.fr/tmp/release-notes/

> What do you think about it?

Hi Stéphane,

Thank you so much for this!  I poked around a little bit on your draft
render of Policy and personally I'm quite happy with it.  The sidebar
management with small screens seemed to work for me and is definitely
better that what we have right now.  I would encourage others to also take
a look and provide feedback.  My inclination is to merge this in a future
release of Policy.

The one minor thing that I noticed was that the version number of Policy
in the left sidebar at the top is very difficult to read because it's
almost the same color as the background.

-- 
Russ Allbery (r...@debian.org)  

Bug#915583: debian sphinx styling: second attempt

[Stéphane Blondon]

Hello,

I've done a new version. It's based on 'sphinx_rtd_theme' theme. So,
to build the site, the package 'python3-sphinx-rtd-theme' requires to
be added to dependencies. A new file 'debian.css' is specific to set
some colors and renderings.

Reusing 'Read the docs' theme allows to have a responsive design automatically.

The theme could be modified more but it could be considered as a first
step which is already usable.

There are temporary demos available:
 - for debian-policy: http://stephane.yaal.fr/tmp/policy/
 - for (draft sphinx) release-notes: http://stephane.yaal.fr/tmp/release-notes/

What do you think about it?

-- 
Stéphane