Creating documentation #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elbeejay
changed the title
elbeejay
changed the title
This was
linked to
issues
Mar 6, 2024
Closed
|
For context I think the huge negative diffs are because I had to rename files to remove spaces, and for the |
g4brielvs
suggested changes
Mar 6, 2024
g4brielvs
approved these changes
Mar 6, 2024
g4brielvs
added a commit
that referenced
this pull request
Mar 6, 2024
* osm_parser doc-strings * calculate_od_raw doc-strings * fetch_pois doc-strings * style network_clean.py * doc-strings conversion_utils.py * doc-strings graphtool.py * doc-strings optimization.py * doc-strings fetch_od.py * doc-strings load_osm.py * doc-strings core.py * symlink the tutorials dir for docs * re-org the docs * readme symlink * move api docs pages * update gitignore * fix symlinks * add some pre-commit hooks * reorg for docs * rename to remove spaces and clean notebook outputs * more space removal and notebook cleaning * revisions to toc and tutorial * Remove auto-generated content from version control --------- Co-authored-by: Gabriel Stefanini Vicente <gvicente@worldbank.org>
g4brielvs
added a commit
that referenced
this pull request
Mar 6, 2024
* osm_parser doc-strings * calculate_od_raw doc-strings * fetch_pois doc-strings * style network_clean.py * doc-strings conversion_utils.py * doc-strings graphtool.py * doc-strings optimization.py * doc-strings fetch_od.py * doc-strings load_osm.py * doc-strings core.py * symlink the tutorials dir for docs * re-org the docs * readme symlink * move api docs pages * update gitignore * fix symlinks * add some pre-commit hooks * reorg for docs * rename to remove spaces and clean notebook outputs * more space removal and notebook cleaning * revisions to toc and tutorial * Remove auto-generated content from version control --------- Co-authored-by: Gabriel Stefanini Vicente <gvicente@worldbank.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.