search

CNES / bulldozer

Bulldozer is a pipeline designed to extract a Digital Terrain Model (DTM) from a Digital Surface Model (DSM).
Apache License 2.0
17 stars 0 forks source link

Missing mkdocs.yml config file to build documentation #2

Open dinesh-k-natarajan opened 5 days ago

dinesh-k-natarajan commented 5 days ago

When trying to build the full documentation following your instructions in the README, the mkdocs serve command executed from the repository's root directory throws an error that Error: Config file 'mkdocs.yml' does not exist.

Please add the missing mkdocs.yml file to the repository (or) add clearer instructions to generate the full documentation.

dimitriLallement commented 5 days ago

Hi,

Thank you for your issue. Indeed, the documentation section of the README is not up to date. We apologize for this bug, we are currently working on a complete documentation refactoring. The new version should be published in November 2024. We've also noticed another issue in the current version of the repository: in the provided configuration file templates (conf directory), the uniform_filter_size parameter is set to 1 although it should be set to 3 => uniform_filter_size : 3. We should fix this in the next version, coming soon.

Thanks,

Dimitri

dinesh-k-natarajan commented 4 days ago

I look forward to the new documentation.

Also, thank you Dimitri for the tip about setting the uniform_filter_size to 3. Now the "bulldozed" DTM output from my DSM makes sense.