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

[Richard Duivenvoorde]

Hi H,

Yeah, definitely needs more work, this is really the vanilla rtd
(ReadTheDocs) theme, besides your points, I also dislike some colors
etc. But the great thing is that do not need designers/css guru's to
make the responsive stuff work etc. Changing some fonts or colors should
be doable.

Your issues (feel free to put them as issues in github):
- updatedisclaimer: probably because I've been playing with moving the
static folder... (see other thread). I was actually hoping to remove it
all the way, and use some javascript to 'inject or remove' such msg.
- about marges & spaces: mmm, have to look into it, such details are
hard to fix (as these are very flexible layouts) but I prefer to keep
this kind of details as is and maybe change our rst if possible to more
fit your idea
- with me it IS scrollable with the mouse middle button? ALternative is
to SHOW a scrollbar which is often ugly?
- coloring: yes, agreed

First we have to decide IF we want to move to this layout (as we can
easily add it to current build too!).

Maybe we can setup a small online doc team meeting this week in an
evening, to speak about and hammer some descisions?

Regards,

Richard


On 18/03/2019 08.05, DelazJ wrote:
> Hi Richard,
> Thanks for your testing. I really like it and after years it visually
> refreshes our documentation.
> I have some issues I don't know whether I should raise them in the doc
> repo or here.
> Here they are:
> 
> - The |updatedisclaimer| does not seem to be substituted
> - I think we should better set the margin in the TOC (the local content
> one) between two different levels: see eg, spacing between "Symbology
> properties" and "Band rendering" and same between the latter and
> "Multiband color" at
> https://qgis.org/test/en/docs/user_manual/working_with_raster/raster_properties.html
> I think we should either keep the same space or reduce it as we go into
> details, ie distance "Sources properties <-> Symbology properties" >= 
> "Symbology properties <-> Band rendering" which is >= "band rendering
> <-> "Multiband color"
> - Still in the above page, it could be nice to have some spacing between
> the "path" and the "View page source" button
> - I like in the left panel the display of the sections of the chapter
> current chapter (a long standing issue report in the repo) and the
> highlighting of the active section. I also like this frame being visible
> all the time. However, I think it should be scrollable since if I'm eg
> at
> https://qgis.org/test/en/docs/user_manual/working_with_vector/vector_properties.html#symbology-properties
> there's no easy way I could get back to qgis gui chapter (at least on my
> 17" screen); the selected chapter was moved at the top of the
> unscrollable area.
> - While I like the general soft coloring of the docs, I'm a bit dubious
> on the background coloring of Processing parameters and sub parameters
> (https://qgis.org/test/en/docs/user_manual/processing_algs/qgis/networkanalysis.html).
> Sorry, no proposal yet.
> - Also it's hard imho to quickly identify the algorithms  (where they
> start or end); maybe should we have a bigger top marging for algorithm
> name. I know I've always complained about how aerate is our Processing
> algs docs, a bit of aeration on top of alg name wouldn't make me unhappy.
> 
> Once again, despite all the issues reported above, I really like the
> path we are taking. Thanks to you.
> 
> Regards,
> Harrissou
> 
> 
> 
> Le ven. 15 mars 2019 à 21:44, Alexandre Neto <senhor.neto at gmail.com
> <mailto:senhor.neto at gmail.com>> a écrit :
> 
>     Thanks!! 
> 
>     I will definitely check it out. 
> 
>     Thanks for the work. 
> 
>     Alex
> 
>     A sex, 15/03/2019, 20:03, Richard Duivenvoorde <rdmailings at duif.net
>     <mailto:rdmailings at duif.net>> escreveu:
> 
>         For those interested,
> 
>         We've been playing around with a more vanilla use of Sphinx to
>         build the
>         documentation:
> 
>         1) because the transifex (and hopefull Github) integration should be
>         better now with newer Sphinx (not ready yet)
>         2) to make it possible for EVERYBODY to build the docs on both
>         Windows,
>         Linux (and probably also Macs) by creating an Python virtual env
>         and run
>         the default Sphinx make/bat file
>         3) because the vanilla ReadTheDocs theme is responsive.
> 
>         If you want to test, I made a little pet-project:
> 
>         https://github.com/rduivenvoorde/qgisdoc
> 
>         With a very small subset of the manual, so a quick build.
> 
>         I also did a full (english) build and uploaded here:
> 
>         https://qgis.org/test/en/
> 
>         Still need some styling stuff and work to make it possible to switch
>         between versions and languages.
> 
>         Not sure if I want to do the pdf generation again, but we could
>         if we
>         want (as on the source nothing has changed).
> 
>         All this to give nobody an excuse to build and write
>         documentation :-)
> 
>         Regards & let us know what you think,
> 
>         Richard Duivenvoorde
>         _______________________________________________
>         Qgis-community-team mailing list for organizing community
>         resources such as documentation, translation etc..
>         Qgis-community-team at lists.osgeo.org
>         <mailto:Qgis-community-team at lists.osgeo.org>
>         https://lists.osgeo.org/mailman/listinfo/qgis-community-team
> 
>     -- 
>     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
>     <mailto:Qgis-community-team at lists.osgeo.org>
>     https://lists.osgeo.org/mailman/listinfo/qgis-community-team
>