Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing mkdocs.yml config file to build documentation #2

Open
dinesh-k-natarajan opened this issue Sep 25, 2024 · 2 comments
Open

Missing mkdocs.yml config file to build documentation #2

dinesh-k-natarajan opened this issue Sep 25, 2024 · 2 comments
Assignees

Comments

@dinesh-k-natarajan
Copy link

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
Copy link
Collaborator

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

@dimitriLallement dimitriLallement self-assigned this Sep 25, 2024
@dinesh-k-natarajan
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants