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

Thorough scouring of docs + doc build infrastructure #135

Merged
merged 24 commits into from Nov 18, 2022

Conversation

jGaboardi
Copy link
Member

@jGaboardi jGaboardi commented Nov 3, 2022

This PR:

  • swaps out conda for micromamba for up to 3x faster environment solves
  • adds dedicated general and spatial package version printing
  • adds linting as a pre-req for testing to run
  • Resolves love and care for docstrings, etc. #141

@jGaboardi
Copy link
Member Author

jGaboardi commented Nov 6, 2022

This PR morphed into some monster doc work (see #141). Going to keep this PR going as a DOC [WIP] and open a new, smaller one specifically for the original intent: CI updates (now being handled in #144).

@jGaboardi jGaboardi mentioned this pull request Nov 6, 2022
@jGaboardi jGaboardi changed the title [WIP] streamline & update CI [WIP] thorough scouring of docs + doc build infrastructure Nov 6, 2022
@jGaboardi jGaboardi added docs WIP Work in progress. For discussion and feedback. Do not merge. and removed CI labels Nov 6, 2022
@jGaboardi
Copy link
Member Author

Major points

  • docstrings
    • review all docstrings for grammar, spelling, punctuation, clarity etc.
    • standardize docstring formatting
    • add math & code formatting where appropriate
  • tutorials
    • review all tutorials and reformat where appropriate
    • clean up cells, code, and viz
    • review all text for grammar, spelling, punctuation, clarity etc.
  • doc site and doc build infrastructure
    • update conf.py and build_docs workflow
    • update Makefile to copy over tutorials form ./notebooks to ./docs/notebooks before rendering
    • add binder links to tutorials
    • rebuilt doc site locally to ensure everything renders properly

@jGaboardi jGaboardi removed the WIP Work in progress. For discussion and feedback. Do not merge. label Nov 8, 2022
@jGaboardi jGaboardi changed the title [WIP] thorough scouring of docs + doc build infrastructure Thorough scouring of docs + doc build infrastructure Nov 8, 2022
@jGaboardi jGaboardi marked this pull request as ready for review November 8, 2022 03:28
@jGaboardi jGaboardi requested a review from sjsrey November 8, 2022 03:28
@jGaboardi
Copy link
Member Author

jGaboardi commented Nov 18, 2022

@sjsrey Got time for a not-so-quick review....? 😨

Copy link
Member

@sjsrey sjsrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huge amount of work here. Awesome.

@jGaboardi jGaboardi merged commit 971a3ea into pysal:main Nov 18, 2022
@jGaboardi jGaboardi deleted the address_warnings_etc branch November 18, 2022 02:34
@@ -1,5 +1,6 @@
nbshpinx
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be nbsphinx, no?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely yes. Good catch.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xref #174

jGaboardi added a commit to jGaboardi/mapclassify that referenced this pull request Feb 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

love and care for docstrings, etc.
4 participants