Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
> For example, HDF4 and HDF4Image points to [2]. > Can you consolidate them into one row? Fixed. Website will be refreshed in a few mins Even -- Spatialys - Geospatial professional services http://www.spatialys.com ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
Hi, Eli! I can see two rows for both HDF4 and HDF5 in [1] which points to the same document. For example, HDF4 and HDF4Image points to [2]. Can you consolidate them into one row? [1] https://gdal.org/drivers/raster/index.html [2] https://gdal.org/drivers/raster/hdf4.html#raster-hdf4 On 12/4/19, 12:00 PM, "gdal-dev on behalf of Eli Adam" wrote: On Sun, Nov 17, 2019 at 5:42 PM Eli Adam wrote: > > https://gdal.org/drivers/raster/index.html > > https://gdal.org/drivers/vector/index.html These two tables have been updated. Please check them over. Let me know if anything needs to be changed/updated. Best regards, Eli ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
On Sun, Nov 17, 2019 at 5:42 PM Eli Adam wrote: > > https://gdal.org/drivers/raster/index.html > > https://gdal.org/drivers/vector/index.html These two tables have been updated. Please check them over. Let me know if anything needs to be changed/updated. Best regards, Eli ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
On Sat, Nov 16, 2019 at 9:12 AM Even Rouault wrote: > > > > If so, then yes if someone contributes it, that'd be welcome. However I > > > think we'd want it to be generated from a Python script from the > > > individual .rst pages, by parsing the directives like ".. > > > supports_create::" that are in those .rst files. That way that would make > > > maintainance of the summary easier (and initial version less tidious that > > > doing that manually) > > OK, so I've added two new directives > > .. built_in_by_default:: > > or > > .. build_dependencies:: put here dependencies name > > and just used them on a couple drivers for demo: > https://github.com/OSGeo/gdal/commit/0b3b1ed25bdde6f49a6515e0431d78bc9729ff83 > > A script that fetches all the information from individual pages > is run automatically at each documentation build and generates a summary table > at > https://gdal.org/drivers/raster/index.html > https://gdal.org/drivers/vector/index.html > > ==> What remains to be done is to go through all driver .rst pages and add > .. built_in_by_default:: or .. build_dependencies:: where appropriate so that > no "???" remains > > Volunteers ? If the old table is a reliable source, I can do a good portion of them. > > > > Migrating the wiki page to the doc could be useful. My own opinion is that > > > driver specific configuration options should be documented in the driver > > > specific page, rather than in a global config option page. Same with /vsi > > I've also added a specific role when you use a configuration option > > :decl_configoption:`FOO` > > Example of use: > > https://github.com/OSGeo/gdal/commit/c8fcb6d941c0251219dbd57f701e5b161ce5085e > > Similarly to the driver list, a script is run at each build to generate an > index of declared configuration options (if several pages declare the same > config option, several links will be created). The result is there: > > https://gdal.org/user/configoptions_index.html > > ==> What remains to be done is tag appropriately configuration options > wherever they are already mentionned and add missing ones. > > Volunteers ? I can work on some already mentioned ones. Thanks for adding this. Best regards, Eli > > Even > > -- > Spatialys - Geospatial professional services > http://www.spatialys.com ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
> The summary table will need some styling. > At the moment I only see the short and and long name columns. > *If* I scroll down to the bottom, then I get a horizontal scroll bar > and can scroll to see that there are more columns. > > I get this with Firefox and Opera on Linux and Firefox and IE11 on Win7 > (yes I need to get a newer windows virtual machine). Hum, displays correctly for me on - Linux, Firefox 70.0.1 - Linux, Chromium 78.0.3904.97 - W10, Edge 44.18362.449.0 with browser in full width. If I reduce the width, I also have the scroll bar. The table is created there: https://github.com/OSGeo/gdal/blob/master/gdal/doc/source/build_driver_summary.py#L67 and that generates the following HTML: We'd probably need help from a Sphinx and/or CSS expert to improve that... But if the width is too small, reducing the column width could make things unreadable, so having at least the short and long name in reduced page width seems a reasonable fallback behaviour. -- Spatialys - Geospatial professional services http://www.spatialys.com ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
Re: [gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
On Sat, 16 Nov 2019, Even Rouault wrote: If so, then yes if someone contributes it, that'd be welcome. However I think we'd want it to be generated from a Python script from the individual .rst pages, by parsing the directives like ".. supports_create::" that are in those .rst files. That way that would make maintainance of the summary easier (and initial version less tidious that doing that manually) OK, so I've added two new directives .. built_in_by_default:: or .. build_dependencies:: put here dependencies name and just used them on a couple drivers for demo: https://github.com/OSGeo/gdal/commit/0b3b1ed25bdde6f49a6515e0431d78bc9729ff83 A script that fetches all the information from individual pages is run automatically at each documentation build and generates a summary table at https://gdal.org/drivers/raster/index.html https://gdal.org/drivers/vector/index.html Thanks. The summary table will need some styling. At the moment I only see the short and and long name columns. *If* I scroll down to the bottom, then I get a horizontal scroll bar and can scroll to see that there are more columns. I get this with Firefox and Opera on Linux and Firefox and IE11 on Win7 (yes I need to get a newer windows virtual machine). -- Andrew C. Aitchison Kendal, UK and...@aitchison.me.uk ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
[gdal-dev] Doc: driver + config options summary pages [was Re: How to know which formats allow editing with ogrinfo?]
> > If so, then yes if someone contributes it, that'd be welcome. However I > > think we'd want it to be generated from a Python script from the > > individual .rst pages, by parsing the directives like ".. > > supports_create::" that are in those .rst files. That way that would make > > maintainance of the summary easier (and initial version less tidious that > > doing that manually) OK, so I've added two new directives .. built_in_by_default:: or .. build_dependencies:: put here dependencies name and just used them on a couple drivers for demo: https://github.com/OSGeo/gdal/commit/0b3b1ed25bdde6f49a6515e0431d78bc9729ff83 A script that fetches all the information from individual pages is run automatically at each documentation build and generates a summary table at https://gdal.org/drivers/raster/index.html https://gdal.org/drivers/vector/index.html ==> What remains to be done is to go through all driver .rst pages and add .. built_in_by_default:: or .. build_dependencies:: where appropriate so that no "???" remains Volunteers ? > > Migrating the wiki page to the doc could be useful. My own opinion is that > > driver specific configuration options should be documented in the driver > > specific page, rather than in a global config option page. Same with /vsi I've also added a specific role when you use a configuration option :decl_configoption:`FOO` Example of use: https://github.com/OSGeo/gdal/commit/c8fcb6d941c0251219dbd57f701e5b161ce5085e Similarly to the driver list, a script is run at each build to generate an index of declared configuration options (if several pages declare the same config option, several links will be created). The result is there: https://gdal.org/user/configoptions_index.html ==> What remains to be done is tag appropriately configuration options wherever they are already mentionned and add missing ones. Volunteers ? Even -- Spatialys - Geospatial professional services http://www.spatialys.com ___ gdal-dev mailing list gdal-dev@lists.osgeo.org https://lists.osgeo.org/mailman/listinfo/gdal-dev
