[Qgis-community-team] QGIS docs: Vanilla build & ReadTheDocs theme

[DelazJ]

Hi all,

Le sam. 25 mai 2019 à 19:39, Anita Graser <anitagraser at gmx.at> a écrit :

> Hi Richard,
>
> I think the ReadTheDocs theme is a huge improvement. Just comparing
> https://docs.qgis.org/testing/en/docs/pyqgis_developer_cookbook/loadlayer.html
> to https://qgis.org/test/en/docs/pyqgis_developer_cookbook/loadlayer.html
> shows how much more readable the code samples are.
>

Indeed the difference is significant. I wonder if we should not use the
whole width of the screen in order to fully see codes and comments without
horizontal scrolling

>
> Are there any blockers to rolling it out?
>

I think the plan was/is to set a repository and have people test and report
issues (I have reported some in this thread) or pull request to ensure that
we lose nothing in the migration. IOW it needs some more testing and
feedback from community.


> Regards,
> Anita
>
>
> On Mon, Mar 18, 2019 at 6:23 PM Alexandre Neto <senhor.neto at gmail.com>
> wrote:
>
>> That is good to know. we should had that xcode information to our writing
>> guidelines and Readme.
>>
>> Alex
>>
>> A seg, 18/03/2019, 16:40, Ian Maddaus <maddaus at protonmail.com> escreveu:
>>
>>> I've successfully built the new documentation using a Mac. A Mac user
>>> would have to install Xcode but that's not a big problem.
>>>
>>
Ian do you think that you can spend some time on writing about this in the
readme? It could be nice we have instructions for macOS users.

Regards,
Harrissou

>
>>>
>>> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
>>> On Monday, March 18, 2019 7:40 AM, Alexandre Neto <senhor.neto at gmail.com>
>>> wrote:
>>>
>>> Sounds good to me.
>>>
>>> IIRC, The docs split was not related to the PyCookbook testing. We can
>>> run tests on them as they are.
>>>
>>> The split would just remove some of the static stuff the guidelines. We
>>> don't need guideline for different versions. And even the Gentle
>>> introduction to GIS, that could be version, we are not updating it
>>> regularly, but we have it replicated for each version of QGIS we release.
>>>
>>> On Mon, Mar 18, 2019 at 11:35 AM Richard Duivenvoorde <
>>> rdmailings at duif.net> wrote:
>>>
>>>> On 2019-03-18 09:13, Alexandre Neto wrote:
>>>> > Hi, I would refrain to change the looks of it right away.
>>>> > I also have my list of improvements for that, but I think it would be
>>>> > better to stabilize the usage of the theme and it's options first, and
>>>> > then do the improvements on top of that.
>>>>
>>>> +1
>>>>
>>>> > Besides, you probably know that already, but there's a way to separate
>>>> > our theme tweaks from the original read the docs theme. We really need
>>>> > to do it the right way so we can update the theme whenever we need.
>>>> >
>>>> > Related subject: we talked about splitting the QGIS docs content. Will
>>>> > we keep using sphinx for the static content?
>>>> >
>>>> > If so, and assuming we are going to use the same theme, it would be
>>>> > better to share it via submodele, otherwise, any theme tweak must be
>>>> > replicated twice.
>>>>
>>>> Yes, but (to me) one reason to split was because I thought to make the
>>>> python cookbook testable it would be better.
>>>> I'm still ok to split (in QGIS version specific and non version
>>>> specific
>>>> docs), but the immidiate need to me is over now (as we do it now it is
>>>> just a rather quick and easy build?).
>>>> I'd like to:
>>>> - move to the rtd theme
>>>> - make translations sync work
>>>> - handle the windows build to work good with make.bat (so some static
>>>> copying)
>>>> But can be done in steps too
>>>>
>>>> Richard
>>>>
>>>
>>> --
>> Alexandre Neto
>> ---------------------
>> @AlexNetoGeo
>> http://sigsemgrilhetas.wordpress.com
>> http://gisunchained.wordpress.com
>> _______________________________________________
>> Qgis-community-team mailing list for organizing community resources such
>> as documentation, translation etc..
>> Qgis-community-team at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such
> as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/qgis-community-team
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20190529/9ddd77cf/attachment.html>