[QGIS-Developer] Building pyqgis doc locally

[matteo]

Hi Denis,

> yes you can limit what you build
> see https://github.com/qgis/pyqgis/blob/master/scripts/build-docs.sh 
> <https://github.com/qgis/pyqgis/blob/master/scripts/build-docs.sh>
> 
> either use --package core/gui/… or --class QgsVector (which will work as 
> QgsVector*)

thanks, it works as expected!

Last (hopefully :) ) question: I'm adding some custom css in the 
_static/css/custom.css file. I've also added:

html_static_path = ['_static']
html_css_files = [
     'css/custom.css',
]

in the conf.py.in file, but when compiling sphinx is complaining:

WARNING: html_static_path entry '_static' does not exist

Do you have any idea why this is happening?

Cheers and thanks again

Matteo
> 
> 
> 
>      > Another approach is to do a PR on the repo, you will have a built
>      > example at https://qgis.org/pyqgis/master_PRXX
>     <https://qgis.org/pyqgis/master_PRXX>
>      > <https://qgis.org/pyqgis/master_PRXX
>     <https://qgis.org/pyqgis/master_PRXX>> (replace XX) when it's finished.
> 
>     and this can be done also to the forked repository right?
> 
> 
> you would need to enable the pages on your repo, I am not sure this will 
> work out-of-the-box.
> 
> 
>      > I believe it would require a bit of love to improve this workflow
>     and
>      > drop the gh-pages branch.
>      >
>      > I hope this helps a bit.
> 
>     Thanks Denis
> 
>     Matteo
> 
> 
>      > Cheers,
>      > Denis
>      >
>      >
>      >
>      > Le mar. 13 déc. 2022 à 08:14, matteo via QGIS-Developer
>      > <qgis-developer at lists.osgeo.org
>     <mailto:qgis-developer at lists.osgeo.org>
>     <mailto:qgis-developer at lists.osgeo.org
>     <mailto:qgis-developer at lists.osgeo.org>>>
>      > a écrit :
>      >
>      >     Hi devs,
>      >
>      >     I've some small ideas to enhance the readthedocs theme of the
>     pyqgis
>      >     documentation and I want make some local test before making a
>     pull
>      >     request.
>      >
>      >     I've cloned this repository (around 7GB?!):
>      >
>      > https://github.com/qgis/pyqgis <https://github.com/qgis/pyqgis>
>     <https://github.com/qgis/pyqgis <https://github.com/qgis/pyqgis>>
>      >
>      >     and then I followed the instruction of the Readme file. It seems
>      >     building but it is literally taking ages (./build-docs.sh
>      >     -qgis-build-dir /home/matteo/dev/qgis-master/).
>      >
>      >     Am I doing something wrong or can I use some shortcut to
>     build it? I'm
>      >     just playing with some css and eventually the config.py.in
>     <http://config.py.in>
>      >     <http://config.py.in <http://config.py.in>> file.
>      >
>      >     Cheers and thanks for any advice
>      >
>      >     Matteo
>      >
>      >     _______________________________________________
>      >     QGIS-Developer mailing list
>      > QGIS-Developer at lists.osgeo.org
>     <mailto:QGIS-Developer at lists.osgeo.org>
>     <mailto:QGIS-Developer at lists.osgeo.org
>     <mailto:QGIS-Developer at lists.osgeo.org>>
>      >     List info:
>     https://lists.osgeo.org/mailman/listinfo/qgis-developer
>     <https://lists.osgeo.org/mailman/listinfo/qgis-developer>
>      >     <https://lists.osgeo.org/mailman/listinfo/qgis-developer
>     <https://lists.osgeo.org/mailman/listinfo/qgis-developer>>
>      >     Unsubscribe:
>     https://lists.osgeo.org/mailman/listinfo/qgis-developer
>     <https://lists.osgeo.org/mailman/listinfo/qgis-developer>
>      >     <https://lists.osgeo.org/mailman/listinfo/qgis-developer
>     <https://lists.osgeo.org/mailman/listinfo/qgis-developer>>
>      >
>