Create documentation - Githubissues

mapcolabora / osm_imports_preparations

This is a proof of concept and a pet project for learning python while preparing data for importing it to OpenStreetMap. Although I will start small (importing trees from Barcelona city council), I aim to set the foundations for adding other types of imports that may (or may not) be added in the future.

http://osmimports.mapcolabora.org/

MIT License

0 stars 0 forks source link

Create documentation #3

Closed ccamara closed 4 years ago

ccamara commented 4 years ago

[x] Configure sphinx or https://www.mkdocs.org/ to generate documentation
[x] Generate documentation from functions
[x] Document the import process for trees (use this example as reference, attaching city council's authorisation)

References:

https://realpython.com/documenting-python-code/

ccamara commented 4 years ago

as per @gabrieldemarmiesse guidance in https://github.com/keras-team/keras-autodoc/issues/68#issuecomment-568305242 this has been solved in commit a3e5af445afd063f6837e8a424337374077272db

ccamara commented 4 years ago

@all-contributors please add gabrieldemarmiesse for Answering Questions

allcontributors[bot] commented 4 years ago

@ccamara

I've put up a pull request to add @gabrieldemarmiesse! :tada:

gabrieldemarmiesse commented 4 years ago

Happy to help :)