search

worldbank / GOSTnets

Convenience wrapper for networkx analysis using geospatial information, focusing on OSM
https://worldbank.github.io/GOSTnets/
MIT License
21 stars 15 forks source link

Creating documentation #61

Closed elbeejay closed 4 months ago

elbeejay commented 4 months ago

PR to create the documentation for this project and migrate it from readthedocs to GitHub Pages (to close #60).

This largely follows the format we developed for the GOSTurban project, this consistency in documentation strategy should help reduce the maintenance burden in the future.

This PR itself doesn't do a ton for formatting or editing of content, focus was on getting the existing content to execute and render in documentation and connecting up the CI etc. I think future PRs will be needed to clean up and improve the content itself (e.g., #62). I'd suggest we merge this so that the team can easily view the hosted documentation and open up issues, make suggestions, propose revisions, etc.

elbeejay commented 4 months ago

Should also close #22 and will close #1.

elbeejay commented 4 months ago

For context I think the huge negative diffs are because I had to rename files to remove spaces, and for the .ipynb files I had to clear their outputs and metadata so they build properly as part of the documentation.