You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@sedona.apache.org by "jbampton (via GitHub)" <gi...@apache.org> on 2024/04/09 13:17:22 UTC
[I] `mkdocs serve` links clean up [sedona]
jbampton opened a new issue, #1326:
URL: https://github.com/apache/sedona/issues/1326
## Expected behavior
Links should be cleaned up and most of the `INFO` messages about links should be removed.
And the links should also work on the GitHub website when viewing the Markdown docs.
## Actual behavior
When running locally:
`mkdocs serve`
we have a lot of extra `INFO` messages that mention our links can be cleaned up.
If you browse the docs directly on GitHub some of these links are broken.
You can run `mkdocs serve 2> mkdocs-serve-output.txt` to pipe the error messages to a file.
Example output below
```
INFO - Building documentation...
INFO - [macros] - Macros arguments: {'module_name': 'main', 'modules': [], 'render_by_default': True, 'include_dir': '', 'include_yaml': [], 'j2_block_start_string': '', 'j2_block_end_string': '',
'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
INFO - [macros] - Extra variables (config file): ['version', 'social', 'sedona', 'sedona_create_release']
INFO - [macros] - Extra filters (module): ['pretty']
INFO - Cleaning site directory
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
- api/python-api.md
- tutorial/python-vector-osm.md
WARNING - A relative path to 'api/rdocs' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING - A relative path to 'api/rdocs' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING - A relative path to 'api/rdocs' is included in the 'nav' configuration, which is not found in the documentation files.
INFO - Doc file 'api/java-api.md' contains an unrecognized relative link '../javadoc/spark/', it was left as is.
INFO - Doc file 'api/snowflake/vector-data/Overview.md' contains an unrecognized relative link '../Constructor', it was left as is. Did you mean 'Constructor.md'?
INFO - Doc file 'api/snowflake/vector-data/Overview.md' contains an unrecognized relative link '../Function', it was left as is. Did you mean 'Function.md'?
INFO - Doc file 'api/snowflake/vector-data/Overview.md' contains an unrecognized relative link '../AggregateFunction', it was left as is. Did you mean 'AggregateFunction.md'?
INFO - Doc file 'api/snowflake/vector-data/Overview.md' contains an unrecognized relative link '../Predicate', it was left as is. Did you mean 'Predicate.md'?
INFO - Doc file 'api/sql/Optimizer.md' contains an unrecognized relative link '../Parameter', it was left as is. Did you mean 'Parameter.md'?
INFO - Doc file 'api/sql/Optimizer.md' contains an unrecognized relative link '../Function/#st_s2cellids', it was left as is. Did you mean 'Function.md#st_s2cellids'?
INFO - Doc file 'api/sql/Optimizer.md' contains an unrecognized relative link '../Predicate/', it was left as is. Did you mean 'Predicate.md'?
INFO - Doc file 'api/sql/Optimizer.md' contains an unrecognized relative link '../../api/sql/Function/#st_geohash', it was left as is. Did you mean 'Function.md#st_geohash'?
INFO - Doc file 'api/sql/Overview.md' contains an unrecognized relative link '../Constructor', it was left as is. Did you mean 'Constructor.md'?
INFO - Doc file 'api/sql/Overview.md' contains an unrecognized relative link '../Function', it was left as is. Did you mean 'Function.md'?
INFO - Doc file 'api/sql/Overview.md' contains an unrecognized relative link '../AggregateFunction', it was left as is. Did you mean 'AggregateFunction.md'?
INFO - Doc file 'api/sql/Overview.md' contains an unrecognized relative link '../Predicate', it was left as is. Did you mean 'Predicate.md'?
WARNING - Doc file 'api/sql/Overview.md' contains a relative link '../../scaladoc/spark/org/apache/sedona/sql/utils/index.html', but the target 'scaladoc/spark/org/apache/sedona/sql/utils/index.html' is not found among
documentation files.
INFO - Doc file 'api/sql/Overview.md' contains an unrecognized relative link '../Optimizer', it was left as is. Did you mean 'Optimizer.md'?
INFO - Doc file 'api/sql/Raster-map-algebra.md' contains an unrecognized relative link '../Raster-operators/', it was left as is. Did you mean 'Raster-operators.md'?
INFO - Doc file 'api/sql/Raster-operators.md' contains an unrecognized relative link '../Function/#st_transform', it was left as is. Did you mean 'Function.md#st_transform'?
INFO - Doc file 'api/sql/Raster-operators.md' contains an unrecognized relative link '../Raster-map-algebra/', it was left as is. Did you mean 'Raster-map-algebra.md'?
INFO - Doc file 'api/sql/Raster-visualizer.md' contains an unrecognized relative link '../Raster-operators/#rs_bandpixeltype', it was left as is. Did you mean 'Raster-operators.md#rs_bandpixeltype'?
INFO - Doc file 'api/sql/Raster-visualizer.md' contains an unrecognized relative link '../Raster-loader/#rs_makeemptyraster', it was left as is. Did you mean 'Raster-loader.md#rs_makeemptyraster'?
INFO - Doc file 'api/sql/Raster-writer.md' contains an unrecognized relative link '../Raster-operators/#rs_band', it was left as is. Did you mean 'Raster-operators.md#rs_band'?
INFO - Doc file 'api/viz/java-api.md' contains an unrecognized relative link '../../javadoc/spark/', it was left as is.
INFO - Doc file 'community/contributor.md' contains an unrecognized relative link '../rule', it was left as is. Did you mean 'rule.md'?
INFO - Doc file 'community/develop.md' contains an unrecognized relative link '../../setup/compile/', it was left as is. Did you mean '../setup/compile.md'?
INFO - Doc file 'community/develop.md' contains an unrecognized relative link '../../setup/compile/#run-python-test', it was left as is. Did you mean '../setup/compile.md#run-python-test'?
INFO - Doc file 'community/publish.md' contains an unrecognized relative link '../../setup/compile', it was left as is. Did you mean '../setup/compile.md'?
INFO - Doc file 'community/publish.md' contains an unrecognized relative link '../../download', it was left as is. Did you mean '../download.md'?
INFO - Doc file 'setup/install-python.md' contains an unrecognized relative link '../release-notes/#known-issue', it was left as is. Did you mean 'release-notes.md#known-issue'?
INFO - Doc file 'setup/install-python.md' contains an unrecognized relative link '../maven-coordinates', it was left as is. Did you mean 'maven-coordinates.md'?
INFO - Doc file 'setup/install-python.md' contains an unrecognized relative link '../../tutorial/jupyter-notebook/', it was left as is. Did you mean '../tutorial/jupyter-notebook.md'?
INFO - Doc file 'setup/install-scala.md' contains an unrecognized relative link '../compile', it was left as is. Did you mean 'compile.md'?
INFO - Doc file 'setup/install-scala.md' contains an unrecognized relative link '../../tutorial/sql-pure-sql/', it was left as is. Did you mean '../tutorial/sql-pure-sql.md'?
INFO - Doc file 'setup/install-scala.md' contains an unrecognized relative link '../../tutorial/demo/', it was left as is. Did you mean '../tutorial/demo.md'?
INFO - Doc file 'setup/overview.md' contains an unrecognized relative link '../../tutorial/viz', it was left as is. Did you mean '../tutorial/viz.md'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../tutorial/raster/', it was left as is. Did you mean '../tutorial/raster.md'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../api/sql/Function/#st_h3celldistance', it was left as is. Did you mean '../api/sql/Function.md#st_h3celldistance'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../tutorial/sql/#visualize-query-results', it was left as is. Did you mean '../tutorial/sql.md#visualize-query-results'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#raster-based-operators', it was left as is. Did you mean
'../api/sql/Raster-operators.md#raster-based-operators'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#raster-to-map-algebra-operators', it was left as is. Did you mean
'../api/sql/Raster-operators.md#raster-to-map-algebra-operators'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../api/sql/Optimizer/#google-s2-based-approximate-equi-join', it was left as is. Did you mean
'../api/sql/Optimizer.md#google-s2-based-approximate-equi-join'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../tutorial/flink/sql/#join-query', it was left as is. Did you mean '../tutorial/flink/sql.md#join-query'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../../api/sql/Optimizer/#geoparquet', it was left as is. Did you mean '../api/sql/Optimizer.md#geoparquet'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../maven-coordinates', it was left as is. Did you mean 'maven-coordinates.md'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../maven-coordinates', it was left as is. Did you mean 'maven-coordinates.md'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../compile', it was left as is. Did you mean 'compile.md'?
INFO - Doc file 'setup/release-notes.md' contains an unrecognized relative link '../overview/#prepare-python-adapter-jar', it was left as is. Did you mean 'overview.md#prepare-python-adapter-jar'?
INFO - Doc file 'setup/flink/install-scala.md' contains an unrecognized relative link '../../maven-coordinates', it was left as is. Did you mean '../maven-coordinates.md'?
INFO - Doc file 'setup/flink/install-scala.md' contains an unrecognized relative link '../../../tutorial/flink/sql', it was left as is. Did you mean '../../tutorial/flink/sql.md'?
INFO - Doc file 'setup/flink/install-scala.md' contains an unrecognized relative link '../../../tutorial/demo/', it was left as is. Did you mean '../../tutorial/demo.md'?
WARNING - Doc file 'setup/snowflake/install.md' contains a relative link './../../../image/snowflake/sedona-snowflake.sql', but the target '../image/snowflake/sedona-snowflake.sql' is not found among documentation files.
Did you mean '../../image/snowflake/sedona-snowflake.sql'?
INFO - Doc file 'tutorial/Advanced-Tutorial-Tune-your-Application.md' contains an unrecognized relative link '../../setup/release-notes/', it was left as is. Did you mean '../setup/release-notes.md'?
INFO - Doc file 'tutorial/jupyter-notebook.md' contains an unrecognized relative link '../../setup/install-python/#install-sedona', it was left as is. Did you mean '../setup/install-python.md#install-sedona'?
INFO - Doc file 'tutorial/jupyter-notebook.md' contains an unrecognized relative link '../../setup/install-python/#prepare-spark-shaded-jar', it was left as is. Did you mean
'../setup/install-python.md#prepare-spark-shaded-jar'?
INFO - Doc file 'tutorial/jupyter-notebook.md' contains an unrecognized relative link '../../setup/install-python/#setup-environment-variables', it was left as is. Did you mean
'../setup/install-python.md#setup-environment-variables'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-map-algebra', it was left as is. Did you mean '../api/sql/Raster-map-algebra.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Overview', it was left as is. Did you mean '../api/sql/Overview.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../demo/', it was left as is. Did you mean 'demo.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../setup/install-python', it was left as is. Did you mean '../setup/install-python.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../jupyter-notebook', it was left as is. Did you mean 'jupyter-notebook.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#rs_metadata', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_metadata'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#rs_georeference', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_georeference'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators', it was left as is. Did you mean '../api/sql/Raster-operators.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_pixelaspoint', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_pixelaspoint'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_worldtorastercoord', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_worldtorastercoord'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_worldtorastercoordx', it was left as is. Did you mean
'../api/sql/Raster-operators.md#rs_worldtorastercoordx'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_worldtorastercoordy', it was left as is. Did you mean
'../api/sql/Raster-operators.md#rs_worldtorastercoordy'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_values', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_values'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_setvalues', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_setvalues'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_band', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_band'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_addband', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_addband'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#rs_resample', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_resample'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-map-algebra', it was left as is. Did you mean '../api/sql/Raster-map-algebra.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-writer/#rs_asraster', it was left as is. Did you mean '../api/sql/Raster-writer.md#rs_asraster'?
WARNING - Doc file 'tutorial/raster.md' contains a relative link '../../image/rasterized-image.png', but the target '../image/rasterized-image.png' is not found among documentation files. Did you mean
'../image/rasterized-image.png'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators#rs_intersects', it was left as is. Did you mean '../api/sql/Raster-operators.md#rs_intersects'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-operators/#raster-predicates', it was left as is. Did you mean '../api/sql/Raster-operators.md#raster-predicates'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-visualizer#rs_asbase64', it was left as is. Did you mean '../api/sql/Raster-visualizer.md#rs_asbase64'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-visualizer#rs_asimage', it was left as is. Did you mean '../api/sql/Raster-visualizer.md#rs_asimage'?
WARNING - Doc file 'tutorial/raster.md' contains a relative link '../../image/DisplayImage.png', but the target '../image/DisplayImage.png' is not found among documentation files. Did you mean '../image/DisplayImage.png'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-visualizer', it was left as is. Did you mean '../api/sql/Raster-visualizer.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-writer#rs_asarcgrid', it was left as is. Did you mean '../api/sql/Raster-writer.md#rs_asarcgrid'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-writer#rs_asgeotiff', it was left as is. Did you mean '../api/sql/Raster-writer.md#rs_asgeotiff'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-writer#rs_aspng', it was left as is. Did you mean '../api/sql/Raster-writer.md#rs_aspng'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../../api/sql/Raster-writer', it was left as is. Did you mean '../api/sql/Raster-writer.md'?
INFO - Doc file 'tutorial/raster.md' contains an unrecognized relative link '../storing-blobs-in-parquet', it was left as is. Did you mean 'storing-blobs-in-parquet.md'?
INFO - Doc file 'tutorial/rdd.md' contains an unrecognized relative link '../sql/#set-up-dependencies', it was left as is. Did you mean 'sql.md#set-up-dependencies'?
INFO - Doc file 'tutorial/rdd.md' contains an unrecognized relative link '../sql/#create-sedona-config', it was left as is. Did you mean 'sql.md#create-sedona-config'?
INFO - Doc file 'tutorial/rdd.md' contains an unrecognized relative link '../sql/#initiate-sedonacontext', it was left as is. Did you mean 'sql.md#initiate-sedonacontext'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../demo/', it was left as is. Did you mean 'demo.md'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../../setup/install-python', it was left as is. Did you mean '../setup/install-python.md'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../jupyter-notebook', it was left as is. Did you mean 'jupyter-notebook.md'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../rdd/#create-a-generic-spatialrdd', it was left as is. Did you mean 'rdd.md#create-a-generic-spatialrdd'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../../api/sql/Visualization_SedonaPyDeck', it was left as is. Did you mean '../api/sql/Visualization_SedonaPyDeck.md'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../../api/sql/Visualization_SedonaKepler', it was left as is. Did you mean '../api/sql/Visualization_SedonaKepler.md'?
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../../api/sql/Function/#st_geohash', it was left as is. Did you mean '../api/sql/Function.md#st_geohash'?
WARNING - Doc file 'tutorial/sql.md' contains a relative link '../../api/scaladoc/spark/org/apache/sedona/sql/utils/index.html', but the target '../api/scaladoc/spark/org/apache/sedona/sql/utils/index.html' is not found
among documentation files.
WARNING - Doc file 'tutorial/sql.md' contains a relative link '../../api/javadoc/sql/org/apache/sedona/sql/utils/index.html', but the target '../api/javadoc/sql/org/apache/sedona/sql/utils/index.html' is not found among
documentation files.
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../rdd#read-other-attributes-in-an-spatialrdd', it was left as is. Did you mean 'rdd.md#read-other-attributes-in-an-spatialrdd'?
WARNING - Doc file 'tutorial/sql.md' contains a relative link '../../api/javadoc/sql/org/apache/sedona/sql/utils/index.html', but the target '../api/javadoc/sql/org/apache/sedona/sql/utils/index.html' is not found among
documentation files.
INFO - Doc file 'tutorial/sql.md' contains an unrecognized relative link '../rdd#read-other-attributes-in-an-spatialrdd', it was left as is. Did you mean 'rdd.md#read-other-attributes-in-an-spatialrdd'?
WARNING - Doc file 'tutorial/sql.md' contains a relative link '../../api/javadoc/sql/org/apache/sedona/sql/utils/index.html', but the target '../api/javadoc/sql/org/apache/sedona/sql/utils/index.html' is not found among
documentation files.
INFO - Doc file 'tutorial/viz.md' contains an unrecognized relative link '../../api/viz/sql', it was left as is. Did you mean '../api/viz/sql.md'?
INFO - Doc file 'tutorial/viz.md' contains an unrecognized relative link '../sql', it was left as is. Did you mean 'sql.md'?
INFO - Doc file 'tutorial/viz.md' contains an unrecognized relative link '../../api/viz/sql/#st_colorize', it was left as is. Did you mean '../api/viz/sql.md#st_colorize'?
INFO - Doc file 'tutorial/zeppelin.md' contains an unrecognized relative link '../../setup/zeppelin/', it was left as is. Did you mean '../setup/zeppelin.md'?
INFO - Doc file 'tutorial/zeppelin.md' contains an unrecognized relative link '../viz', it was left as is. Did you mean 'viz.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/flink/Overview', it was left as is. Did you mean '../../api/flink/Overview.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../setup/maven-coordinates', it was left as is. Did you mean '../../setup/maven-coordinates.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../demo/', it was left as is. Did you mean '../demo.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/flink/Constructor', it was left as is. Did you mean '../../api/flink/Constructor.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/flink/Function/#st_transform', it was left as is. Did you mean '../../api/flink/Function.md#st_transform'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/flink/Predicate', it was left as is. Did you mean '../../api/flink/Predicate.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../demo/', it was left as is. Did you mean '../demo.md'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/flink/Function/#st_s2cellids', it was left as is. Did you mean '../../api/flink/Function.md#st_s2cellids'?
INFO - Doc file 'tutorial/flink/sql.md' contains an unrecognized relative link '../../../api/Predicate/', it was left as is.
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Constructor/', it was left as is. Did you mean '../../api/snowflake/vector-data/Constructor.md'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/', it was left as is. Did you mean '../../api/snowflake/vector-data/Function.md'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Constructor/', it was left as is. Did you mean '../../api/snowflake/vector-data/Constructor.md'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function#st_transform', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_transform'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_s2cellids', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_s2cellids'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Predicate/', it was left as is. Did you mean '../../api/snowflake/vector-data/Predicate.md'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_3ddistance', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_3ddistance'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_force_2d', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_force_2d'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_geometryn', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_geometryn'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_makevalid', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_makevalid'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_multi', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_multi'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_numgeometries', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_numgeometries'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_precisionreduce', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_precisionreduce'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/#st_subdivideexplode', it was left as is. Did you mean
'../../api/snowflake/vector-data/Function.md#st_subdivideexplode'?
INFO - Doc file 'tutorial/snowflake/sql.md' contains an unrecognized relative link '../../../api/snowflake/vector-data/Function/', it was left as is. Did you mean '../../api/snowflake/vector-data/Function.md'?
INFO - Documentation built in 3.57 seconds
INFO - [23:00:05] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [23:00:05] Serving on http://127.0.0.1:8000/
INFO - Shutting down...
```
## Steps to reproduce the problem
Run:
`mkdocs serve` and watch the output in the console
## Settings
Sedona version = master
Apache Spark version = ?
Apache Flink version = ?
API type = Scala, Java, Python?
Scala version = 2.11, 2.12, 2.13?
JRE version = 1.8, 1.11?
Python version = Python 3.11.6
Environment = Standalone, AWS EC2, EMR, Azure, Databricks?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sedona.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "jbampton (via GitHub)" <gi...@apache.org>.
jbampton closed issue #1326: `mkdocs serve` links clean up
URL: https://github.com/apache/sedona/issues/1326
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "mebrein (via GitHub)" <gi...@apache.org>.
mebrein commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2072043951
I issued a pull request, could you have a look? https://github.com/apache/sedona/pull/1359
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "mebrein (via GitHub)" <gi...@apache.org>.
mebrein commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2049481101
To explain a bit futher. A lot of these constructs where like:
```<img width="250" src="../../image/st_snap/st-snap-applied.png" title="ST_Snap applied example"/>```
I replaced them with
```{: width="250px"}```
so the relative paths are now correct, alt and title properties being applied and size is set correctly.
Following occurrences:
```Use [ST_S2CellIds](../Function/#st_s2cellids) to generate cell ID```
I replaced them with
```Use [ST_S2CellIds](Function.md#st_s2cellids)```
adding the .md suffix and removing the leading which I think is not necessary. Also the slash just before the # anchor can be removed.
I hope this works out beautifully for all editors/ide's I currently use Jetbrains ide, and the links appear to work better, at least for me...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "mebrein (via GitHub)" <gi...@apache.org>.
mebrein commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2049422198
Ok, I think I got it. I issued the following pull request.
https://github.com/apache/sedona/pull/1334
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "jbampton (via GitHub)" <gi...@apache.org>.
jbampton commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2420663816
Thanks @mebrein :+1:
Looks like most of the links have been cleaned up.
A lot less messages in the console now when running `mkdocs build` or `mkdocs serve`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "jbampton (via GitHub)" <gi...@apache.org>.
jbampton commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2047795094
I was looking at the official guide on links here:
https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
On quick review I was not able to find much on links in the Material docs
https://squidfunk.github.io/mkdocs-material/setup/
But you can setup the website locally and build and serve it to test the links.
There is the guide on the website here:
https://sedona.apache.org/latest/setup/compile/#compile-the-documentation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "mebrein (via GitHub)" <gi...@apache.org>.
mebrein commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2047759247
So I think the docs need some love.
I wonder when I change these links (just some examples)
```
[Sedona version release notes](../../setup/release-notes/)
[how to contribute](../rule)
<img src="../../image/ide-java-1.png"/>
[ST_S2CellIds](../Function/#st_s2cellids)
```
to
```
[Sedona version release notes](../setup/release-notes.md)
[how to contribute](rule.md)
<img src="../image/ide-java-1.png"/>
[ST_S2CellIds](Function.md#st_s2cellids)
```
Then the links will work locally in my editor and on my local mkdocs server. But will these kind of changes break the website?
When I change/fix all links this would affect like 25 files.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] `mkdocs serve` links clean up [sedona]
Posted by "jbampton (via GitHub)" <gi...@apache.org>.
jbampton commented on issue #1326:
URL: https://github.com/apache/sedona/issues/1326#issuecomment-2061687499
We have an issue with the changes mentioned here:
https://github.com/apache/sedona/pull/1334#discussion_r1569108112
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org