[gdal-dev] New driver on doc index?

Even Rouault even.rouault at spatialys.com
Mon Mar 11 04:50:20 PDT 2024


Abel,
>
> Hi,
>
> I’m obtaining this error:
>
> /__w/gdal/gdal/doc/source/drivers/vector/miramon.rst: WARNING: 
> document isn't included in any toctree
>
> The file of the rst is miramon.rst but the name of the driver is 
> MiraMonVector (to make it different from MiraMonRaster, in a future).
>
> So, this is a problem?
>
the mismatch between the miramon.rst file and the name of the driver? no

but the warning is legit, and warnings are turned as errors in the doc 
build process. Otherwise your new page would never have been linked from 
anywhere else.

> or I should add miramon.rst in any index?
>
some quick googling of the error message would have lead you to 
https://sphinx-intro-tutorial.readthedocs.io/en/latest/common_issues.html

which suggests to add the new file to a index.rst file, in that 
instance: doc/source/drivers/vector/index.rst

Even

-- 
http://www.spatialys.com
My software is free, but my time generally not.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/gdal-dev/attachments/20240311/c57661aa/attachment.htm>


More information about the gdal-dev mailing list